Fuzion Logo
fuzion-lang.dev — The Fuzion Language Portal
JavaScript seems to be disabled. Functionality is limited.

ordered_map

container.ordered_map

§
(OK 
type
, V 
type
, ks array OK, vs array V)
:
Map OK, V
 is

ordered_map -- an immutable map from ordered keys OK to values V

Lookup performance is O(log size) since it uses binary search in a
sorted array. When deterministic performance is desired, an ordered map
should be preferred over a hash map.

performance of creation of the map is in O(n log n) where n is
keys.length.

Type Parameters

Constructors

entry represents the pair of key and value at the given
index i of the ordered map.

Functions

§
(k container.ordered_map.OK, v container.ordered_map.V)
 => 
container.this.ordered_map container.ordered_map.OK container.ordered_map.V
add mapping from k to v
§
 => 
String  
[Redefinition of  container.Map.as_string]
create a string containing all mappings
§
 => 
Type  
[Inherited from  Any]
Get the dynamic type of this instance. For value instances `x`, this is
equal to `type_of x`, but for `x` with a `ref` type `x.dynamic_type` gives
the actual runtime type, while `type_of x` results in the static
compile-time type.

There is no dynamic type of a type instance since this would result in an
endless hierarchy of types. So for Type values, dynamic_type is redefined
to just return Type.type.
§
(k container.Map.K)
 => 
bool  
[Inherited from  Map]
check if key k is present in the set of keys
§
(k container.ordered_map.OK)
 => 
option container.ordered_map.V  
[Redefinition of  container.Map.index [ ]]
get the value k is mapped to, or nil if none.

performance is O(log size).
get an array of all key/value pairs in this map
§
 => 
Sequence container.Map.K  
[Inherited from  Map]
get a sequence of all keys in this map
§
 => 
String  
[Inherited from  Any]
convenience prefix operator to create a string from a value.

This permits usage of `$` as a prefix operator in a similar way both
inside and outside of constant strings: $x and "$x" will produce the
same string.
§
 => 
i32  
[Redefinition of  container.Map.size]
number of entries in this map

redefines:

a sorted array of entries of this map
§
 => 
Sequence container.Map.V  
[Inherited from  Map]
get a sequence of all values in this map

Type Functions

§
 => 
String  
[Inherited from  Type]
string representation of this type to be used for debugging.

result has the form "Type of '<name>'", but this might change in the future

redefines:

§
 => 
Type  
[Inherited from  Type]
There is no dynamic type of a type instance since this would result in an
endless hierarchy of types, so dynamic_type is redefined to just return
Type.type here.

redefines:

create an empty instance of ordered_map
§
(T 
type
)
 => 
bool  
[Inherited from  Type]
Is this type assignable to a type parameter with constraint `T`?

The result of this is a compile-time constant that can be used to specialize
code for a particular type.

is_of_integer_type(n T : numeric) => T : integer
say (is_of_integer_type 1234) # true
say (is_of_integer_type 3.14) # false

it is most useful in conjunction preconditions or `if` statements as in

pair(a,b T) is

=>

or

val(n T) is

§
 => 
String  
[Inherited from  Type]
name of this type, including type parameters, e.g. 'option (list i32)'.
§
 => 
String  
[Inherited from  Type]
convenience prefix operator to create a string from a value.

This permits usage of `$` as a prefix operator in a similar way both
inside and outside of constant strings: $x and "$x" will produce the
same string.

NYI: Redefinition allows the type feature to be distinguished from its normal counterpart, see #3913

redefines:

§
 => 
Type  
[Inherited from  Any]
Get a type as a value.

This is a feature with the effect equivalent to Fuzion's `expr.type` call tail.
It is recommended to use `expr.type` and not `expr.type_value`.

`type_value` is here to show how this can be implemented and to illustrate the
difference to `dynamic_type`.