Collection Library API - brombres/Rogue GitHub Wiki

IndexedSet.rogue

class IndexedSet<<$DataType>>

extends Object

incorporates IteratorPreferred

Properties

Name Type Description
data [$DataType:Int]
lookup List<<$DataType>>

Methods

Signature Return Type Description
init()
init( existing:IndexedSet<<$DataType>> )
add( value:$DataType ) Int
clear()
cloned() IndexedSet<<$DataType>>
count() Int
difference( other:IndexedSet<<$DataType>> )
get( index:Int ) $DataType
get( key:$DataType, &locate ) Int?
intersection( other:IndexedSet<<$DataType>> )
iterator() TableKeysIterator<<$DataType,Int>>
operator&( other:IndexedSet<<$DataType>> ) IndexedSet<<$DataType>>
operator-( other:IndexedSet<<$DataType>> ) IndexedSet<<$DataType>>
operator|( other:IndexedSet<<$DataType>> ) IndexedSet<<$DataType>>
print_to( buffer:PrintWriter )
remove( key:$DataType ) Int?
set( key:$DataType, value:Int )
to<<String>>() String
union( other:IndexedSet<<$DataType>> )

IteratorPreferred.rogue

class IteratorPreferred [aspect]

Description

Signals the compiler that when an object with this aspect is being iterated over in a forEach, .iterator() or .reader() should be used instead of .count/.get().

List.rogue

class [Rogue::Character:Rogue::Int][]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native126 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type [Character:Int] Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ANSIColor[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native99 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type ANSIColor Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ANSIColorMode[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native69 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type ANSIColorMode Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class BigInt[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native32 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type BigInt Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class BMPBitField[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native62 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type BMPBitField Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class BMPVersion[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native71 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type BMPVersion Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class Byte[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Global Methods

Signature Return Type Description
create( file:File ) Byte[]

Properties

Name Type Description
@native1 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Byte Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
init( encoded:String, &base64, &hex )
add( encoded:String, &base64, &hex )
cloned() Byte[]
has_byte_order_mark() Logical
is_valid_utf8() Logical
to<<Variant>>() Variant
to<<String>>( &base64, &hex, &uppercase, &lowercase ) String Returns a these bytes encoded as a string. If &hex is specified, returns a string of hexadecimal digit pairs encoding each byte. Uppercase by default unless &lowercase is specified.

If &base64 is specified, returns a base64-encoded string.

Example:

  println Byte[][0,127,160,255]->String(&hex) # "007FA0FF"
to_base64( &omit_padding ) String

class Character[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native3 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Character Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ConsoleEvent[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native53 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type ConsoleEvent Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ConsoleEventType[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native35 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type ConsoleEventType Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class File[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native91 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type File Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class FileDiffHunk[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native117 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type FileDiffHunk Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class FileDiffLine[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native116 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type FileDiffLine Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class FileListingOption[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native30 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type FileListingOption Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class GitIgnoreLine[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native118 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type GitIgnoreLine Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class GitIgnoreSection[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native120 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type GitIgnoreSection Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class GlobalID[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native16 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type GlobalID Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class HuffmanNode[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native79 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type HuffmanNode Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class Int32[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native33 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Int32 Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class Int[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native22 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Int Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class List<<$DataType>>

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native37 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type $DataType Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ListIterator<<$DataType>> [compound]

augments ListIterator<<$DataType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( list:List<<$DataType>>, [position=0:Int], [limit=-1:Int] ) ListIterator<<$DataType>>

Properties

Name Type Description
limit Int
list List<<$DataType>>
position Int

Methods

Signature Return Type Description
description() String
has_another() Logical
has_another( n:Int ) Logical
operator==( other:ListIterator<<$DataType>> ) Logical
peek( [lookahead=0:Int] ) $DataType
print_to( buffer:PrintWriter )
read() $DataType
read_another() Optional<<$DataType>>
to<<Object>>() Boxed<<ListIterator<<$DataType>>>>
to<<String>>() String
to<<Variant>>() Variant
to<<$DataType[]>>( [result=null:List<<$DataType>>] ) List<<$DataType>>
to_list( [result=null:List<<$DataType>>] ) List<<$DataType>>
type_info() TypeInfo

class ListReader<<$DataType>>

extends Object

incorporates Reader<<$DataType>>

Properties

Name Type Description
is_limited Logical
limit Int
list List<<$DataType>>
position Int

Methods

Signature Return Type Description
init( list:List<<$DataType>>, [position=0:Int] )
init( list:List<<$DataType>>, position:Int, limit:Int )
close()
has_another() Logical
on_end_use()
on_use() ListReader<<$DataType>>
peek() $DataType
position() Int
read() $DataType
read( buffer:List<<$DataType>>, limit:Int ) Int
reset()
seek( pos:Int )
skip( n:Int )
to<<$DataType[]>>() List<<$DataType>>
to<<String>>() String

class ListType [aspect]

class ListWorkingCopy<<$ElementType>> [compound]

augments ListWorkingCopy<<$ElementType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( list:$ElementType[] ) ListWorkingCopy<<$ElementType>>

Properties

Name Type Description
list $ElementType[]

Methods

Signature Return Type Description
description() String
on_use() $ElementType[]
on_end_use( working_copy:$ElementType[] )
operator==( other:ListWorkingCopy<<$ElementType>> ) Logical
print_to( buffer:PrintWriter )
to<<Object>>() Boxed<<ListWorkingCopy<<$ElementType>>>>
to<<String>>() String
to<<Variant>>() Variant
type_info() TypeInfo

class ListWriter<<$DataType>>

extends Object

incorporates Writer<<$DataType>>

Properties

Name Type Description
list List<<$DataType>>
position Int

Methods

Signature Return Type Description
init( list:List<<$DataType>> )
close()
flush()
on_use() ListWriter<<$DataType>>
on_end_use( err:Exception ) Exception
position() Int
reset()
seek_end()
seek( pos:Int )
skip( n:Int )
write( list:List<<$DataType>> )
write( value:$DataType )

class Logical[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native107 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Logical Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class MethodInfo[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native10 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type MethodInfo Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class Object[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native98 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Object Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ParameterInfo[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native11 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type ParameterInfo Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class PromiseHandler[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native111 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type PromiseHandler Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class PromiseState[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native110 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type PromiseState Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class PropertyInfo[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native9 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type PropertyInfo Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
get( name:String ) PropertyInfo?
to<<Variant>>() Variant

class Real32[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native85 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Real32 Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class Real[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native59 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Real Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ScanPattern[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native21 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type ScanPattern Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class SignalConnection[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native39 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type SignalConnection Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class SignalConnection[][]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native41 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type SignalConnection[] Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class SignalID[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native15 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type SignalID Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class Span[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native51 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Span Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class StackTraceFrame[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native19 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type StackTraceFrame Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class String[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native4 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type String Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
conjoin( [conjunction="and":String] ) String ["alpha","beta","gamma"].conjoin -> "alpha, beta, and gamma"
join( [separator="\n":String], [output=String():String] ) String A better version of join() for String lists
to<<Variant>>() Variant

class StringEncoding[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native27 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type StringEncoding Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class StyledCharacter[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native61 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type StyledCharacter Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<<$DataType,$DataType>>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native96 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<$DataType,$DataType>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<<$DataType,Rogue::Int>>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native46 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<$DataType,Int>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<<$KeyType,$ValueType>>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native43 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<$KeyType,$ValueType>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<<$KeyType,$ValueType[]>>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native93 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<$KeyType,$ValueType[]>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::Character,[Rogue::Character:Rogue::Int]>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native125 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<Character,[Character:Int]>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::Character,Rogue::Int>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native124 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<Character,Int>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::GlobalID,$DataType>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native38 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<GlobalID,$DataType>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::GlobalID,Rogue::SignalID>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native14 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<GlobalID,SignalID>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::Int32,Rogue::HuffmanNode>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native80 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<Int32,HuffmanNode>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::SignalID,Rogue::SignalConnection[]>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native40 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<SignalID,SignalConnection[]>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::SignalID,Rogue::String>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native18 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<SignalID,String>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::String,(Function(Rogue::CommandLineParser))>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native100 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<String,(Function(CommandLineParser))>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::String,Rogue::GitIgnoreSection>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native119 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<String,GitIgnoreSection>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::String,Rogue::GlobalID>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native26 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<String,GlobalID>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::String,Rogue::Object>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native97 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<String,Object>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::String,Rogue::SignalID>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native17 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<String,SignalID>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::String,Rogue::String>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native42 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<String,String>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::Variant,Rogue::Variant>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native7 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<Variant,Variant>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TableEntry<Rogue::VariantEntry,Rogue::Int>[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native47 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TableEntry<<VariantEntry,Int>> Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class TypeInfo[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native8 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type TypeInfo Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class UnixConsoleMouseEventType[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native52 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type UnixConsoleMouseEventType Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class Variant[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native6 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type Variant Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class VariantEntry[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native48 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type VariantEntry Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class WAVChannel[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native86 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type WAVChannel Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class WAVFormat[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native87 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type WAVFormat Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class XML[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native89 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type XML Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<String>>() String
to<<Variant>>() Variant
to<<String>>( &formatted ) String
write( builder:String, &formatted ) String

class XMLNodeType[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native88 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type XMLNodeType Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

class ZipEntry[]

augments List<<$DataType>>

extends Object

incorporates Recyclable, ListType

Properties

Name Type Description
@native92 RogueCNativeProperty
capacity Int
count Int
element_size Int
element_type ZipEntry Used by native code to determine sizeof($DataType)
is_borrowed Logical
is_ref_array Logical

Methods

Signature Return Type Description
to<<Variant>>() Variant

ListLookupTable.rogue

class ListLookupTable<<$KeyType,$ValueType>>

extends [$KeyType:$ValueType[]]

Properties

Name Type Description
bin_mask Int
bins TableEntry<<$KeyType,$ValueType[]>>[]
count Int
cur_entry TableEntry<<$KeyType,$ValueType[]>>
cur_entry_index Int
first_entry TableEntry<<$KeyType,$ValueType[]>>
last_entry TableEntry<<$KeyType,$ValueType[]>>
sort_function Function(TableEntry<<$KeyType,$ValueType[]>>,TableEntry<<$KeyType,$ValueType[]>>)->Logical Optional function which, if defined, is used to place each entry into the correct position as entries are added or redefined.

Methods

Signature Return Type Description
add( key:$KeyType, value:$ValueType ) ListLookupTable<<$KeyType,$ValueType>>
add( other:ListLookupTable<<$KeyType,$ValueType>> ) ListLookupTable<<$KeyType,$ValueType>>
cloned() ListLookupTable<<$KeyType,$ValueType>>
contains( key:$KeyType ) Logical
remove( key:$KeyType, value:$ValueType ) $ValueType
set( key:$KeyType, value:$ValueType ) ListLookupTable<<$KeyType,$ValueType>>

ListRewriter.rogue

class ListRewriter<<$DataType>> [compound]

augments ListRewriter<<$DataType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( list:List<<$DataType>>, [read_index=0:Int], [write_index=0:Int] ) ListRewriter<<$DataType>>

Properties

Name Type Description
list List<<$DataType>>
read_index Int
write_index Int

Methods

Signature Return Type Description
description() String
finish()
has_another() Logical
operator==( other:ListRewriter<<$DataType>> ) Logical
peek( [lookahead=0:Int] ) $DataType
print_to( buffer:PrintWriter )
read() $DataType
read_another() Optional<<$DataType>>
to<<Object>>() Boxed<<ListRewriter<<$DataType>>>>
to<<String>>() String
to<<String[]>>() String[]
to<<Variant>>() Variant
type_info() TypeInfo
write( value:$DataType )

class ListRewriterObject<<$DataType>>

extends Object

Properties

Name Type Description
list List<<$DataType>>
read_index Int
write_index Int

Methods

Signature Return Type Description
init( list:List<<$DataType>>, [read_index=0:Int], [write_index=0:Int] )
finish()
has_another() Logical
peek( [lookahead=0:Int] ) $DataType
read() $DataType
read_another() Optional<<$DataType>>
write( value:$DataType )

Node.rogue

class Node<<$ExtendedNodeType>>

extends Object

incorporates IteratorPreferred

Properties

Name Type Description
count Int
first_child $ExtendedNodeType
last_child $ExtendedNodeType
next $ExtendedNodeType
parent $ExtendedNodeType
structure_modified Logical

Methods

Signature Return Type Description
add( new_child:$ExtendedNodeType )
add_next( new_sibling:$ExtendedNodeType )
apply( fn:Function($ExtendedNodeType) ) Recursively traverse this node and all its children, calling fn(node) on each.
children() NodeIterator<<$ExtendedNodeType>>
clear()
clear_structure_modified()
contains( node:$ExtendedNodeType ) Logical
detach( &preserve_next ) $ExtendedNodeType Detaches this node from its current parent and all of its siblings.

preserve_next
  When true, this node's 'next' is not cleared. Nodes that are the head
  sibling of a list can be added as children; this flag is used internally
  to making sure a node is detached while not accidentally removing all
  successive nodes.
discard( fn:Function($ExtendedNodeType)->Logical ) $ExtendedNodeType Discards (detaches) any node in this tree that match the query. fn(node) should return true to discard that node, false to keep it. Returns the original root or null if the root has been discarded.
dispatch_on<<$VisitorType>>( visitor:$VisitorType ) $ExtendedNodeType
dispatch_on_visit<<$VisitorType>>( visitor:$VisitorType )
find( query_fn:Function($ExtendedNodeType)->Logical ) $ExtendedNodeType
get( index:Int ) $ExtendedNodeType
insert( new_child:$ExtendedNodeType, [before_index=0:Int] )
insert_next( new_sibling:$ExtendedNodeType )
insert_previous( new_sibling:$ExtendedNodeType )
iterator() NodeIterator<<$ExtendedNodeType>>
last_sibling() $ExtendedNodeType
locate( child:$ExtendedNodeType ) Int? Returns 0-based index of child in this node's children or else null.
node_name() String
remove_children() $ExtendedNodeType
remove_first() $ExtendedNodeType
remove_last() $ExtendedNodeType
remove( child:$ExtendedNodeType ) $ExtendedNodeType
remove_at( index:Int ) $ExtendedNodeType
replace_child( old_child:$ExtendedNodeType, new_child:$ExtendedNodeType )
set( index:Int, node:$ExtendedNodeType )
set_first( node:$ExtendedNodeType )
set_last( node:$ExtendedNodeType )
set_next( node:$ExtendedNodeType )
set_parent( new_parent:$ExtendedNodeType )
set_structure_modified( setting:Logical )
split() (head:$ExtendedNodeType,tail:$ExtendedNodeType) Returns (head,tail)
to<<String>>() String

class NodeIterator<<$ExtendedNodeType>> [compound]

augments NodeIterator<<$ExtendedNodeType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( cur:$ExtendedNodeType ) NodeIterator<<$ExtendedNodeType>>

Properties

Name Type Description
cur $ExtendedNodeType

Methods

Signature Return Type Description
description() String
has_another() Logical
operator==( other:NodeIterator<<$ExtendedNodeType>> ) Logical
print_to( buffer:PrintWriter )
read() $ExtendedNodeType
read_another() $ExtendedNodeType?
to<<$ExtendedNodeType[]>>() $ExtendedNodeType[]
to<<Object>>() Boxed<<NodeIterator<<$ExtendedNodeType>>>>
to<<String>>() String
to<<Variant>>() Variant
to_list() $ExtendedNodeType[]
type_info() TypeInfo

class NodeVisitor<<$ExtendedNodeType>>

extends Object

Methods

Signature Return Type Description
on( node:$ExtendedNodeType ) $ExtendedNodeType Default handler - overload for specialized `node` types if desired.
on_visit( node:$ExtendedNodeType ) Overload this method to handle extended node types
visit( node:$ExtendedNodeType ) $ExtendedNodeType
visit_children( node:$ExtendedNodeType ) Overload this method to handle extended node types if desired

Quicksort.rogue

class Quicksort<<$DataType>>

extends Object

Global Methods

Signature Return Type Description
sort( list:List<<$DataType>>, compare_fn:Function($DataType,$DataType)->Logical ) List<<$DataType>>
sort( list:List<<$DataType>>, compare_fn:Function($DataType,$DataType)->Logical, i1:Int, i2:Int )

Set.rogue

class Set<<$DataType>>

extends [$DataType:$DataType]

Properties

Name Type Description
bin_mask Int
bins TableEntry<<$DataType,$DataType>>[]
count Int
cur_entry TableEntry<<$DataType,$DataType>>
cur_entry_index Int
first_entry TableEntry<<$DataType,$DataType>>
last_entry TableEntry<<$DataType,$DataType>>
sort_function Function(TableEntry<<$DataType,$DataType>>,TableEntry<<$DataType,$DataType>>)->Logical Optional function which, if defined, is used to place each entry into the correct position as entries are added or redefined.

Methods

Signature Return Type Description
add( value:$DataType )
cloned() Set<<$DataType>>
difference( other:Set<<$DataType>> )
intersection( other:Set<<$DataType>> )
operator&( other:Set<<$DataType>> ) Set<<$DataType>>
operator-( other:Set<<$DataType>> ) Set<<$DataType>>
operator|( other:Set<<$DataType>> ) Set<<$DataType>>
print_to( buffer:PrintWriter )
union( other:Set<<$DataType>> )

ShakerSort.rogue

class ShakerSort<<$DataType>>

extends Object

Global Methods

Signature Return Type Description
single_forward_pass( list:List<<$DataType>>, compare_fn:Function($DataType,$DataType)->Logical ) Logical
single_forward_pass( list:List<<$DataType>>, i1:Int, i2:Int, compare_fn:Function($DataType,$DataType)->Logical ) Logical Returns 'true' if any changes occur.
single_reverse_pass( list:List<<$DataType>>, compare_fn:Function($DataType,$DataType)->Logical ) Logical
single_reverse_pass( list:List<<$DataType>>, i1:Int, i2:Int, compare_fn:Function($DataType,$DataType)->Logical ) Logical Returns 'true' if any changes occur.
sort( list:List<<$DataType>>, compare_fn:Function($DataType,$DataType)->Logical ) List<<$DataType>>

Spreadsheet.rogue

class Cell

extends Object

Properties

Name Type Description
column Column
format Format
row Row
value Variant

Methods

Signature Return Type Description
init( column:Column, row:Row, [value=undefined:Variant] )
delete_column()
delete_row()
is_empty() Logical
print( builder:String, [width=0:Int], &csv )
set_value( value:Variant )
to<<Int64>>() Int64
to<<Int>>() Int
to<<Logical>>() Logical
to<<Real>>() Real
to<<String>>() String

class Column

extends Header

Properties

Name Type Description
cells Cell[]
index Int
table Spreadsheet

Methods

Signature Return Type Description
delete()
set( row_index:Int, value:Variant )
to<<String>>() String

class CSVParser

extends CSVScanner

Properties

Name Type Description
builder String
column Int
row Int
row_builder Variant
scanner Scanner
table Spreadsheet

Methods

Signature Return Type Description
init( table:Spreadsheet, csv:String )
init( table:Spreadsheet, file:File )
init( table:Spreadsheet, scanner:Scanner )
on_row()
on_cell( content:String )

class CSVScanner

extends Object

Properties

Name Type Description
builder String
column Int
row Int
scanner Scanner

Methods

Signature Return Type Description
init( csv:String )
init( file:File )
init( scanner:Scanner )
consume_eol()
next_is_end_of_cell() Logical
next_is_eol() Logical
on_row()
on_table()
on_cell( content:String )
read_quoted_content()
read_regular_content()
scan_cell()
scan_row()
scan_table()

class Format

extends Object

Global Properties

Name Type Description
GENERAL GeneralFormat
MONEY MoneyFormat

Global Methods

Signature Return Type Description
create( value:Variant ) Format

Methods

Signature Return Type Description
parse( value:Variant ) Variant
print( value:Variant, builder:String, width:Int )

class GeneralFormat

extends Format

Methods

Signature Return Type Description
init()
print( value:Variant, builder:String, width:Int )

class Header

extends Object

Properties

Name Type Description
cells Cell[]
index Int
table Spreadsheet

Methods

Signature Return Type Description
init( table:Spreadsheet, index:Int )
add( cell:Cell )
count() Int
find( query:Function(Cell)->Logical ) Cell?
get( index:Int ) Cell
get( query:Function(Cell)->Logical ) Cell[]

class MoneyFormat

extends Format

Methods

Signature Return Type Description
init()
parse( value:Variant ) Variant
print( value:Variant, builder:String, width:Int )

class Row

extends Header

Properties

Name Type Description
cells Cell[]
index Int
table Spreadsheet

Methods

Signature Return Type Description
delete()
set( column_index:Int, value:Variant )
to<<String>>() String

class Spreadsheet

extends Object

Properties

Name Type Description
columns Column[]
rows Row[]

Methods

Signature Return Type Description
init()
init( csv:String )
init( csv_file:File )
add_column() Column
add_row() Row
add_column( values:Variant ) Column
add_row( values:Variant ) Row
delete_column( index:Int )
delete_row( index:Int )
get( column:Int, row:Int ) Variant
save( file:File )
set( column:Int, row:Int, value:Variant )
to<<String>>() String
to_csv() String

Table.rogue

class [Rogue::Variant:Rogue::Variant]

augments Table<<$KeyType,$ValueType>>

extends Object

incorporates TableType

Properties

Name Type Description
bin_mask Int
bins TableEntry<<Variant,Variant>>[]
count Int
cur_entry TableEntry<<Variant,Variant>>
cur_entry_index Int
first_entry TableEntry<<Variant,Variant>>
force_string_keys Logical
last_entry TableEntry<<Variant,Variant>>
sort_function Function(TableEntry<<Variant,Variant>>,TableEntry<<Variant,Variant>>)->Logical Optional function which, if defined, is used to place each entry into the correct position as entries are added or redefined.

Methods

Signature Return Type Description
init( other:[Variant:Variant] )
find( key:Variant ) TableEntry<<Variant,Variant>>
set( key:Variant, value:Variant )
to<<Variant>>() Variant

class Table<<$KeyType,$ValueType>>

extends Object

incorporates TableType

Properties

Name Type Description
bin_mask Int
bins TableEntry<<$KeyType,$ValueType>>[]
count Int
cur_entry TableEntry<<$KeyType,$ValueType>>
cur_entry_index Int
first_entry TableEntry<<$KeyType,$ValueType>>
last_entry TableEntry<<$KeyType,$ValueType>>
sort_function Function(TableEntry<<$KeyType,$ValueType>>,TableEntry<<$KeyType,$ValueType>>)->Logical Optional function which, if defined, is used to place each entry into the correct position as entries are added or redefined.

Methods

Signature Return Type Description
init()
init( bin_count:Int )
init( other:Table<<$KeyType,$ValueType>> )
add( other:Table<<$KeyType,$ValueType>> )
at( index:Int ) $ValueType
clear()
cloned() Table<<$KeyType,$ValueType>>
contains( key:$KeyType ) Logical
contains( query:Function($ValueType)->Logical ) Logical
discard( query:Function(TableEntry<<$KeyType,$ValueType>>)->Logical )
disconnect_on_change( key:$KeyType )
entries() TableEntriesIterator<<$KeyType,$ValueType>> Returns an iterator compound.
entry_at( index:Int ) TableEntry<<$KeyType,$ValueType>>
find( key:$KeyType ) TableEntry<<$KeyType,$ValueType>>
first() $ValueType
first( query:Function($ValueType)->Logical ) $ValueType?
get( key:$KeyType ) $ValueType
get( key:$KeyType, default_value:$ValueType ) $ValueType
get( query:Function($ValueType)->Logical ) $ValueType[]
is_empty() Logical
keys() TableKeysIterator<<$KeyType,$ValueType>> Returns an iterator compound.
locate( query:Function($ValueType)->Logical ) $KeyType[]
map<<$NewTableType>>( [fn=null:Function($KeyType,$ValueType,$NewTableType)] ) $NewTableType
on_change( key:$KeyType, signal_id:SignalID )
operator==( other:Table<<$KeyType,$ValueType>> ) Logical
print_to( buffer:PrintWriter )
random() TableEntry<<$KeyType,$ValueType>>
remove( entry:TableEntry<<$KeyType,$ValueType>> ) TableEntry<<$KeyType,$ValueType>>
remove( key:$KeyType ) $ValueType
remove( query:Function($ValueType)->Logical ) $ValueType[] Returns the list of values that pass the query function while removing them from this table.
remove_at( index:Int ) $ValueType
reverse_entries() TableReverseEntriesIterator<<$KeyType,$ValueType>> Returns an iterator compound.
set( key:$KeyType, value:$ValueType )
set_sort_function( sort_function:Function(TableEntry<<$KeyType,$ValueType>>,TableEntry<<$KeyType,$ValueType>>)->Logical )
sort( compare_fn:Function(TableEntry<<$KeyType,$ValueType>>,TableEntry<<$KeyType,$ValueType>>)->Logical )
sorted( compare_fn:Function(TableEntry<<$KeyType,$ValueType>>,TableEntry<<$KeyType,$ValueType>>)->Logical ) Table<<$KeyType,$ValueType>>
to<<String>>() String
to<<Variant>>() Variant
to_list() $ValueType[]
values() TableValuesIterator<<$KeyType,$ValueType>> Returns an iterator compound.

class TableEntriesIterator<<$KeyType,$ValueType>> [compound]

augments TableEntriesIterator<<$KeyType,$ValueType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( cur:TableEntry<<$KeyType,$ValueType>> ) TableEntriesIterator<<$KeyType,$ValueType>>

Properties

Name Type Description
cur TableEntry<<$KeyType,$ValueType>>

Methods

Signature Return Type Description
description() String
has_another() Logical
operator==( other:TableEntriesIterator<<$KeyType,$ValueType>> ) Logical
peek() TableEntry<<$KeyType,$ValueType>>
peek( lookahead:Int ) TableEntry<<$KeyType,$ValueType>>
print_to( buffer:PrintWriter )
read() TableEntry<<$KeyType,$ValueType>>
read_another() TableEntry<<$KeyType,$ValueType>>?
to<<Object>>() Boxed<<TableEntriesIterator<<$KeyType,$ValueType>>>>
to<<String>>() String
to<<Variant>>() Variant
to<<TableEntry<<$KeyType,$ValueType>>[]>>( [result=null:TableEntry<<$KeyType,$ValueType>>[]] ) TableEntry<<$KeyType,$ValueType>>[]
to_list( [result=null:TableEntry<<$KeyType,$ValueType>>[]] ) TableEntry<<$KeyType,$ValueType>>[]
type_info() TypeInfo

class TableEntry<<$KeyType,$ValueType>>

extends Object

Properties

Name Type Description
adjacent_entry TableEntry<<$KeyType,$ValueType>> next entry in bin - same hash code after masking
hash Int
key $KeyType
next_entry TableEntry<<$KeyType,$ValueType>> next entry in order - could be totally different hash
on_change SignalID
previous_entry TableEntry<<$KeyType,$ValueType>> previous entry in order
value $ValueType

Methods

Signature Return Type Description
init( _key:$KeyType, _value:$ValueType, _hash:Int )
to<<String>>() String

class TableKeysIterator<<$KeyType,$ValueType>> [compound]

augments TableKeysIterator<<$KeyType,$ValueType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( cur:TableEntry<<$KeyType,$ValueType>> ) TableKeysIterator<<$KeyType,$ValueType>>

Properties

Name Type Description
cur TableEntry<<$KeyType,$ValueType>>

Methods

Signature Return Type Description
description() String
has_another() Logical
operator==( other:TableKeysIterator<<$KeyType,$ValueType>> ) Logical
peek() $KeyType
peek( lookahead:Int ) $KeyType
print_to( buffer:PrintWriter )
read() $KeyType
read_another() $KeyType?
to<<Object>>() Boxed<<TableKeysIterator<<$KeyType,$ValueType>>>>
to<<String>>() String
to<<Variant>>() Variant
to<<$KeyType[]>>( [result=null:$KeyType[]] ) $KeyType[]
to_list( [result=null:$KeyType[]] ) $KeyType[]
type_info() TypeInfo

class TableReverseEntriesIterator<<$KeyType,$ValueType>> [compound]

augments TableReverseEntriesIterator<<$KeyType,$ValueType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( cur:TableEntry<<$KeyType,$ValueType>> ) TableReverseEntriesIterator<<$KeyType,$ValueType>>

Properties

Name Type Description
cur TableEntry<<$KeyType,$ValueType>>

Methods

Signature Return Type Description
description() String
has_another() Logical
operator==( other:TableReverseEntriesIterator<<$KeyType,$ValueType>> ) Logical
peek() TableEntry<<$KeyType,$ValueType>>
peek( lookahead:Int ) TableEntry<<$KeyType,$ValueType>>
print_to( buffer:PrintWriter )
read() TableEntry<<$KeyType,$ValueType>>
read_another() TableEntry<<$KeyType,$ValueType>>?
to<<Object>>() Boxed<<TableReverseEntriesIterator<<$KeyType,$ValueType>>>>
to<<String>>() String
to<<Variant>>() Variant
to<<TableEntry<<$KeyType,$ValueType>>[]>>( [result=null:TableEntry<<$KeyType,$ValueType>>[]] ) TableEntry<<$KeyType,$ValueType>>[]
to_list( [result=null:TableEntry<<$KeyType,$ValueType>>[]] ) TableEntry<<$KeyType,$ValueType>>[]
type_info() TypeInfo

class TableType [aspect]

class TableValuesIterator<<$KeyType,$ValueType>> [compound]

augments TableValuesIterator<<$KeyType,$ValueType>>

incorporates CommonCompoundMethods

Global Methods

Signature Return Type Description
create( cur:TableEntry<<$KeyType,$ValueType>> ) TableValuesIterator<<$KeyType,$ValueType>>

Properties

Name Type Description
cur TableEntry<<$KeyType,$ValueType>>

Methods

Signature Return Type Description
description() String
has_another() Logical
operator==( other:TableValuesIterator<<$KeyType,$ValueType>> ) Logical
peek() $ValueType
peek( lookahead:Int ) $ValueType
print_to( buffer:PrintWriter )
read() $ValueType
read_another() $ValueType?
to<<Object>>() Boxed<<TableValuesIterator<<$KeyType,$ValueType>>>>
to<<String>>() String
to<<Variant>>() Variant
to<<$ValueType[]>>( [result=null:$ValueType[]] ) $ValueType[]
to_list( [result=null:$ValueType[]] ) $ValueType[]
type_info() TypeInfo

Timsort.rogue

class Timsort<<$DataType>>

extends Object

Global Properties

Name Type Description
gallop_threshold Int
runs Span[]

Global Methods

Signature Return Type Description
sort( list:List<<$DataType>>, compare_fn:Function($DataType,$DataType)->Logical )

Wiring.rogue

routine wiring<<$Type>>()

class WiringManager [singleton]

extends Object

Properties

Name Type Description
wires [String:Object]

Methods

Signature Return Type Description
wiring<<$Type>>() $Type
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️