API-Documentation

feature to signal an abort of a computation.
contains the final value of a computation.
used e.g. in Sequence.reduce

analysis -- condition qualifier for conditions used by static analysis tools

analysis is a condition qualifier that is used for conditions that are
not intended to be checked at run time but only by static analysis tools.

Any -- parent feature of all features that do not have an explicit parent

array -- create initialized one-dimensional immutable array

array -- one-dimensional immutable array

This is the result type of array(type, i32, i32 -> T) which creates an
initalized immutable array

Note: This uses dummy unit-type args to avoid
name clash with routine array(T,length,init).

array(length0, length1) -- two-dimensional immutable array

array provides two-dimensional immutable arrays. These are actually
one-dimensional immutable arrays with an additional access function with
two index parameters.

array(length0, length1) -- two-dimensional immutable array

array provides two-dimensional immutable arrays. These are actually
one-dimensional immutable arrays with an additional access function with
two index parameters.

array(length0, length1, length2) -- three-dimensional immutable array

array provides three-dimensional immutable arrays. These are actually
one-dimensional immutable arrays with an additional access function with
three index parameters.

array(length0, length1, length2) -- three-dimensional immutable array

array provides three-dimensional immutable arrays. These are actually
one-dimensional immutable arrays with an additional access function with
three index parameters.

benchmark f for milli_seconds (1s warm up)

only completed iterations are counted, any iterations started before
the one second warmup has elapsed are not counted either

returns: iterations per second

benchmark f by iterating it for nano_seconds

only completed iterations are counted, any iterations started before
warm_up_nano_seconds has elapsed are not counted either

returns: iterations per second

bitset -- persistent set of unsigned integers

bool -- Standard Fuzion type 'bool'

We need to apologize to George Boole for crippling his name a bit,
just to safe us from typing one more letter. But at least we stop
here and do not use boo, bo or similar.

bool is a choice type that can either be TRUE of FALSE.

Note that 'TRUE' and 'FALSE' themselves are not of type 'bool'.
Routines 'true' and 'false' are the preferred way to get a constant
value of type 'bool'.

cache result of f for cache key T

This is best explained by the following example:


The cache implemented works on a global level.

character_encodings -- unit feature to group character encodings

choice -- feature used for choice types

choice types provide algebraic sum types of all the generic arguments
provided to choice. A instance of a choice type is a tagged union of
the types provided as actual generic type parameters. This concept is
also called variant, sum type or coproduct in other contexts.

Syntactic sugar of the Fuzion language permits an alternative notation
for choice types with actual generics as follows

A | B | C | ...

which is equivalent to

choice A B C ...

The parser will directly convert the first notation into a choice type
with actual generics.

A field of choice type can be assigned a value of the same choice type
or of any of the actual generic type arguments provided to the choice
feature.

Two choice types choice A B and choice B A that differ only in the order
of their actual generic arguments are treated as different types.

Named choice types can be constructed through inheritance, i.e.,

C : choice A B is {}

creates a choice type of A and B with the name C. Two named choice types
D and E that inherit from choice with the same actual generic arguments in
the same order are nevertheless different types and their values are not
assignable to one another.

Named choice types may declare or inherit additional inner features as long
as these features are not fields. Also, declared inner features must not
build a closure that accesses outer features. Additional parents must be
unit types, i.e., they must not declare fields nor access features of any
of their outer features.

Note that all types provided must be distinct, it is not possible to
repeat the same type as in choice i32 i32 or float | float. If a sum
type of two or more equal types is desired, these types must first be
wrapped into a new type as illustrated in the following example:

Say we want to store a temperature that is given as a 32 bit integer
in degrees centigrade or degrees Fahrenheit. So we define two wrapper
features

centigrade(degrees i32) is {}
fahrenheit(degrees i32) is {}

Now we define the choice type using the wrapped i32 types, which are
distinct:

has_fever(temp centigrade | fahrenheit) bool is ...

When passing arguments to this feature, we need to wrap them accordingly:

has_fever (centigrade 37)
has_fever (fahrenheit 99)

When matching the choice type, we use the wrapper types and access the
argument field 'degrees' to access the i32 stored inside

match temp

NYI: Once Fuzion's match expression supports destructuring as well, we should
be able to extract the degrees directly as in

match temp

A choice type with no actual generic arguments is isomorphic to 'void', i.e, it
is a type that has an empty set of possible values.

codepoint -- represents a unicode codepoint

concur -- unit feature to group concurrency related features

Cons -- feature used to define abstract Cons cells

A Cons is a ref to a cell that contains a head and a tail

cons -- feature used to define simple, non-lazy Cons cells

A cons is a cell that contains a head and a tail

Const_String -- feature used for string constants in Fuzion source code

Const_String cannot be called directly, instances are created implicitly by the
backend.

container -- unit feature to group features that provide some kind of
data structure to store and retrieve values

debug -- features related to debug setting

debug is a condition qualifier that enables conditions if debugging is
enabled.

this is true if and only if the debug level is greater than zero.

debug(i32) is a condition qualifier that enables conditions if debugging is
enabled at the given debug-level.

Current debug level, used by condition qualified debug(i32)

This can be controlled using the "-debug=" option to the fz tool:


Whatever option was set at compile time will be used when running a
compile program.

effect -- abstract parent feature for effects

effect provides a means to perform effectful operations. Instances
of effect are installed in the current environment while their code is
executed. The code may access the effect via <type>.env.

effect mode is an enum that determines how an instance of effect is used

envir -- unit feature to group environment related features

equals -- feature that compares two values using the equality relation
defined in their type

error represents an error condition described by a message string

NYI: Future versions of error might be equipped with a stack trace if
debugging is enabled

install given exit handler and run code with it.

exit -- effect that terminates a computation in exit

exit with the currently stored exit code

exit with a code argument calls exit.exit code, i.e., it uses the
current exit effect to exit with the given message.

Exit_Handler -- abstract exit

f128 -- 128 bit floating point values

f16 -- 16 bit floating point values

f32 -- 32 bit floating point values


f32 are binary32-numbers as defined in the IEEE 754-2019 standard, see
https://ieeexplore.ieee.org/servlet/opac?punumber=8766227

f64 -- 64 bit floating point values


f64 are binary64-numbers as defined in the IEEE 754-2019 standard, see
https://ieeexplore.ieee.org/servlet/opac?punumber=8766227

boolean value "false"

Note that this value is of unit type >>FALSE<<, not of type >>bool<<, i.e.,
if it is used for type inference as in

my_boolean := FALSE

you will get a variable of type >>FALSE<<, it will not be possible to assign
>>TRUE<< to it. You can use >>false<< as an alternative to get type >>bool<<.

boolean value "false" as a constant of type >>bool<<.

float -- floating point values


float is the abstract parent of concrete floating point features such as
f32 or f64.

Function -- generic function with arbitrary number of arguments and result

R is the result type of the function, A are the argument types of the function

fuzion -- unit feature to group fuzion-infrustructure related features

NYI visibility=module

initializes a new handle with the given initial value

this uses the handles instance from the current environment

type of the reference to the cell that holds a value of type T which can be updated
using the handles interface

create a new handle2 using the handles2 instance from the current environment

handle value created by 'handles2.new'

short-hand for creating and installing an empty set of handles of given type.

handles provide a means to create handles that refer to update-able
cells.

handles is a state monad. It provides features to create several
handles that refer to modifiable value and features to 'get', 'put' or
'update' this value.

an example of using handles is shown below, handle (singular) is an
alias to initialize a new handle with the given initial value. handle0 T
is the type that allows passing around handles.


the example also shows the difference between handles and the mutate effect:
while both provide a way to store and update a mutable value, a handle can be
passed around between features. meanwhile, mutables are not a type that can be
given to other features, only values can. handles essentially provide an
abstraction of pointers, implemented natively in Fuzion.

short-hand for accessing handles monad for given type in current environment

handles2 provide a means to create handles that refer to update-able
cells.

handles is a state monad. It provides features to create several
handles that refer to modifiable value and features to 'get', 'put' or
'update' this value.

For performance, this implementation uses mutable state. It can consequently
only be used as a one-way monad.

short-hand for creating an empty set of handles of given type.

has_interval -- feature for integers that can define an interval

hash of a value

i128 -- 128-bit signed integer values

i16 -- 16-bit signed integer values

i32 -- 32-bit signed integer values

i64 -- 64-bit signed integer values

i8 -- 8-bit signed integer values

id -- routine implementing the identity function

When called, this feature returns its argument

id -- feature returing the unary identity function

When called, this feature returns a unary function that implements the
identity for the given type.

infix = -- infix operation as short-hand for 'equals'

infix operator to create a list from head h and lazy tail t.

This is convenient to append an element before a list as in

0 : [1,2,3,4].as_list

or to create lists by recursion, e.g., a an endless list containing
integer 1 repeatedly is

ones => 1 : ones

does this come strictly before other?

infix <= -- infix operation as short-hand for 'lteq'

three-way comparison between this and other.

result is < 0 if this < other
result is > 0 if this > other
result is = 0 if this = other

infix = -- infix operation as short-hand for 'equals'

does this come strictly after other?

does this come after other?

infix ≟ -- infix operation as short-hand for 'equals'

infix ≤ -- infix operation as short-hand for 'lteq'

does this come after other?

three-way comparison between this and other.

result is < 0 if this < other
result is > 0 if this > other
result is = 0 if this = other

does this come strictly before other?

does this come strictly after other?

int -- signed integer values of arbitrary size

shorthand to create an int via an i64

integer -- abstract ancestor of integer numbers

integer is the abstract ancestor of integer numbers that provides operations
from numeric plus a devision remainder operation %, bitwise logical operations,
shift operations and gcd. Also, integers can be used to build fractions.

io -- unit feature to group io related features

Lazy

convenience routine to create a list from head h and lazy tail t.

list -- feature used to define lists

list provides an abstract type for a sequence of elements of the same type.

A list sequence may be empty and contain no element, or it may have a fixed
or even an infinite number of elements.

The core of the implementation of an actual list lies in the implementation
of the actual Cons cell a non-empty list consists of.

Lists can typically be traversed using only immutable data. This makes them
more flexible than streams that require to store and update their state.

A list is immutable, so it can be reused and shared between threads.
Compared to a stream, a list may require more (heap) allocation.

lteq -- feature that compares two values using the lteq relation
defined in their type

maximum of two values

minimum of two values

monad -- generic monad

A monad in X is just a monoid in the category of endofunctors of X, with
product × replaced by composition of endofunctors and unit set by the
identity endofunctor.

Don't be scared, in Java terms: A monad is a means to compose functions
applied to generic types.

Monoid -- parent feature for monoids

A monoid is an abstraction for a type with an associative operation and
an identity element. Examples are (integers/infix +/0), (float/infix *,1),
(string/concat/""), etc.

create a new mutable value of type T with initial value v

short-hand for accessing mut effect in current environment

an interface defining a mutable array

mutate -- an effect that permits creation and mutation of mutable values.

This effect is typically used to work with mutable values. You can create
a mutable value as follows

v := mutate.env.new i32 42

and then modify it using

v <- 666

To read it, call 'get' as in

say "v is {v.get}"

Convenience feature 'mut' and type inference allow the creation to be
written as

v := mut 42

NYI: syntax sugar to read mutable field using

w := v + 1

instead of

w := v.get + 1

is not supported yet.

net -- unit feature to group net related features

nil -- value for options that are not present

This is a unit type that is preferred to represent instances that are
not present, e.g, in an option.

num -- unit feature to group features that relate in some way to numbers

num_option with 1 argument provides an short-hand to wrap a value into a
num_option

Using this enables to write

o := num_option x

instead of

o num_option TypeOfX := x

num_option -- optional numeric values

This is a pseudo-numeric type that handles one additional
value: nil. Any operation on nil will result in nil for a
numeric result or false for a boolean result.

numeric -- parent of all numeric features

oneway_monad -- heir feature of all one-way monads.

oneway_monad is the heir feature of all one-way monads. A one-way monad is
a monadic feature that can be accessed only through the environment and
that will be replaced in the environment whenever a new instance is created.

option with 1 argument provides an short-hand to wrap a value into an option

Using this enables to write

o := option x

insted of

o option TypeOfX := x

option -- feature wrapping a value or nothing

option represents an optional value of type T

outcome with 1 argument provides an short-hand to wrap a value into a
outcome

Using this enables to write

o := outcome x

instead of

o outcome TypeOfX := x

outcome -- result type for functions that may return an error

outcome is a choice type that represents the result of a routine that
may either produce something useful or fail producing an error condition.

Several error conditions are needed if there are several very different
reasons for an operation to fail, e.g.

get_data (u User, t Type) outcome data IO_Error Permission_Error is

read_file t Type outcome data IO_Error is

Note that 'outcome data IO_Error' is not assignment compatible with
'outcome data IO_Error Permission_Error', it has to be unwrapped first.
This unwrapping, however, requires very little boilerplate, it is done
using the '?' on the result of the call to 'read_file': This unwraps
'outcome data IO_Error' into 'IO_Error', which would be returned abruptly,
and 'data', which would be returned normally. Both are assignment
compatible to 'outcome data IO_Error Permission_Error', so everything
is fine.

panic -- effect that terminates a computation in panic

panic with no argument returns panic.env, the currently installed
panic handler.

panic with a msg argument calls panic.panic msg, i.e., it uses the
current panic effect to panic with the given message.

Panic_Handler -- abstract panic

pedantic -- condition qualifier for conditions that are pedantic

pedantic is a condition qualifier for conditions a pedantic purist would require,
but that a more relaxed hacker would prefer to do without.

currently, pedantic always returns true.

property -- unit feature to group features that can be inherited by other
features if they fulfill certain properties such as defining a partial
order

quantor -- unit type feature containing quantors ∀ and ∃.

quantor provides for_all and exists-quantors for use in contracts qualified
for analysis.

random -- effect that provides random numbers

random with no argument returns random.env, i.e., the currently installed
source of randomness.

Random_Handler -- abstract source of random numbers

This provides the random number input to be used by the 'random' effect.
Implementation may be dumb sequences of pseudo-random numbers or high-qualiity
cryptographic random number generators

A Random_Handler contains an immutable state, repeated calls to 'get' result
in the same value. To produce a sequence of different random numbers, 'next'
must be used to create a new instance of 'Random_Handler' before 'get' can be
used to obtain the new random number.

safety -- condition qualifier for conditions that are required for safety

safety is a condition qualifier that is used for conditions that are
absolutely required to ensure safety.

This must never be disabled if safety is of any concern. Applications
run with safety disabled typically have security vulnerabilities that
allow system takeover via manipulated input data.

Currently, the value of this can be controlled by setting the fuzion.safety
Java property when calling the fz tool, for example like this:


If the program is compiled, not interpreted, then the value of this option
at compile time will be used.

A handy shortcut for stdout.println, output a line break.

say -- shortcut for io.out.println

A handy shortcut for io.out.println, output string representation of
an object followed by a line break.

Sequence -- ancestor for features that can be converted to a 'list' or a
'stream'

Sequences are empty, finite or infinite ordered collections of instances
of a given type. Sequences may calculate elements lazily on demand.

Sequence is a 'ref' type, i.e., different sub-features may be assigned
to a field of type 'Sequence'.

Heirs of Sequence must implement either 'as_list' or 'as_stream'. Failure
to implement any of these results in an endless recursion when the Sequence
is used.

change the currently stored exit code

simple_effect provides a simple means to define and use an effect

user-defined effects should inherit from this feature and add
operations as inner features or fields of function type.

To install this effect to execute a function, simple_effect.use
can be called.

state with 1 argument is short hand for a state containing unit and
initial_value

install new state monad for type S and run r within that state monad

return result of r.

state -- represent a state using a monad

this can be used both as plain or as a oneway monad to store a state
in a way orthogonal to the actual computation.

short-hand for getting state monad for given type in current environment

short-hand for modifying state monad for given type in current environment

short-hand for accessing state monad for given type in current environment

short-hand for setting state monad for given type in current environment

stream -- a stream of values

A stream contains mutable state, so it cannot be reused or shared
between threads.

The mutable nature of streams requires particular prudence, as even basic
actions, such as calling as_string on a stream will consume values and thus
change the state of the stream, as the following example demonstrates:

a := [1, 2, 3, 4, 5].as_stream
say a
say a

In this example, the first invocation of say will print "1, 2, 3, 4, 5",
the second invocation will print "".

NYI: Check if stream should be replaced by a lazy list, which is a choice
of either nil or a tuple (head, tail). This should avoid the need to store
mutable state.

streams -- unit type defining features related
to streams but not requiring an instance

string -- immutable sequences of utf8 encoded unicode characters

sum -- generic sum of the elements of a Sequence of numeric.

This allows summing the elements of a list, as in

l := [1,2,3]
say (sum l) # '6'

time -- unit feature to group time related features

transducers map one reducing function to
another reducing function. this enables composition
and reuse of map, filter, reduce etc.

see https://clojure.org/reference/transducers
for in depth information on transducers

usage example:

human(age i32) is
td := (transducer (Sequence i32) i32 human).type
ages := td.map (x -> x.age)
gt_ten := td.filter (x -> x > 10)
xf := ages ∘ gt_ten
say ([human 4, human 12, human 30].into xf) # [12,30]


TA result type
B input type
C transduced type

boolean value "true"

Note that this value is of unit type >>TRUE<<, not of type >>bool<<, i.e.,
if it is used for type inference as in

my_boolean := TRUE

you will get a variable of type >>TRUE<<, it will not be possible to assign
>>FALSE<< to it. You can use >>true<< as an alternative to get type >>bool<<.

boolean value "true" as a constant of type >>bool<<.

convenience routine to create a new instance of 'try' and run 'f' in
it.

try -- simple exception effect

try provides an operation 'raise' that immediately stops execution and
returns an 'error' wrapped in an 'outcome'.

convenience routine to create a new instance of 'try' and run 'f' in
it. Return the result of 'f' directly or panic in case 'f' calls
'try.env.raise'.

tuple -- feature used to define tuple types

tuple types provide algebraic product types of all the generic arguments
provided to tuple.

The values within a tuple 'tuple A B C' can be accessed via the tuple's
argument field 'values' followed by a selector referring to the generic
argument's position: 'values.0', 'values.1' and 'values.2', respectively.

Syntactic sugar of the Fuzion language permits an alternative notation
to create values of tuple types as follows

t := (a, b, c, ... )

is equivalent to

t := tuple a b c ...

The actual generic types are inferred from the static types of the values
'a', 'b', 'c', ... the tuple is created from.

Similarly, syntactic sugar for the destructuring of tuples can be used
to access the values as in

(a, b, c, ...) := t

In destructurings, we can denote values we are not interested in using
'_' as in

(_, b) := ("first", "second")

which will set 'b' to '"second"' and drop the first element of the tuple.

As an example, say we want to identify a person by its name and its age,
so we can define

a := ("Alice" , 11)
b := ("Bob" , 22)
c := ("Claire", 33)

Then, we could extract Bob's age using

(_, age) := b

or Claire's name using

(name, _) := c

Destructuring also works for general features, e.g.

point (x,y i32) is {}

p := point 3, 4
(px, py) := p # will set px to 3 and py to 4

and the destructured value can then be used to create a tuple

t := (px, py) # will create tuple<i32,i32> instance

however, tuples are not assignment compatible with general features even
if they would destructure into the same types, i.e.,

u tuple i32 i32 = p # will cause compile time error
q point = (7, 12) # will cause compile time error

The unit tuple '()' can be used as a short-hand to create the empty tuple
'tuple'. The empty tuple can be destructured like any other tuple
using

() := ()

even though this has no effect.

An instance of the single tuple 'tuple A' with sole element 'a' can not
be created using syntactic sugar '(a)', this will produce the plain
value of 'a' instead. However, destructuring of a single tuple is possible:

(a0) := tuple a

which is equivalent to

a0 := a

NYI: A single tuple 'tuple A' is currently not assignment compatible with
type 'A', which would make handling of general tuples easier.

tuples and destructuring can be used to swap two elements or create a
permutation as in

(a, b) := (b, a)
(o, t, a, n) := (n, a, t, o)

A tuple type with no actual generic arguments is isomorphic to 'unit', i.e, it
is a type that has only one single value: '()'.

Type -- parent feature of all type features

type features 'f.type' are declared implicitly for every feature f.
Type features do not contain state, they are unit types.

All type features inherit directly (Any.type) or indirectly (all
others type features) from this feature.

universe feature to determine the compile-time type of an expression.

This is to be called without an actual type passed to `T`, but `T` should be
inferred from the actual value argument `_`.

The value arugment is evaluated and ignored.

The result is the type of the value argument boxed into a ref value and returned
as a value of type `Type`.

examples:

`type_of "bla"` is `String`
`type_of (panic "***")` will terminate

universe feature to determine the compile-time type of an expression.

This is to be called without an actual type passed to `T`, but `T` should be
inferred from the result type of the actual value argument `_`.

The function passed as value arugment is ignored, it is not called.

The result is the result type of the value argument boxed into a ref value and
returned as a value of type `Type`.

examples:

`type_of_lazy ()->"bla"` is Type of `String`
`type_of_lazy ()->(panic "***")` is Type of `void`.

NYI: Fuzion should have better syntax sugar for lazy value arguments such that
we do not need the `()->` prefix to create a lambda. Then, `type_of` could
have a lazy argument and `type_of_lazy` could be removed.

Types -- features related to Type but not requiring an instance of Type

u128 -- 128-bit unsigned integer values

u16 -- 16-bit unsigned integer values

u32 -- 32-bit unsigned integer values

u64 -- 64-bit unsigned integer values

u8 -- 8-bit unsigned integer values

unsigned integer of arbitrary size, including zero
represented by its bit sequence

shorthand to create an uint via an u64

Unary -- function that takes exactly one argument and returns a result

T is the result type of the function, U is the argument type of the function

For unary functions, function composition is possible if the result type of
the first function matches the argument type of the second function.

unit -- value to be used as result of features that do not return a result

NOTE: unit corresponds to type void in C, Java, etc.

unit is the preferred result type for features that return without producing
a result value. These are features that typically have an outside effect
such as

println(String s) unit is ...

or features that change the state of an instance such as

increment(delta i64) unit is

The Fuzion language implementation automatically inserts code that returns the
unit value as a result of these features, there is no need for an explicit unit
result as in

increment(delta i64) unit is

but it is allowed to return unit explicitly if desired.

Another application of the unit type are generic features when certain generic
values are not needed and can be ignored. An example could be a generic map
implementation map K V that maps values of type K to values of type V. Using
unit as the actual generic argument for V, e.g., map string unit creates a
map that stores no data for each key, which essentially turns the map into a
set of the map's keys.

The Fuzion library knows several different unit types. Another example is nil,
which is used as the alternative type in an option. This enables the use of
option void, which can store two distinct values, void and nil.

Other unit types in Fuzion are TRUE and FALSE.

The simplest syntax to create a value of unit type is an empty block '{}'. Note
that an empty tuple 'tuple' is a different unit value of a different type and
the syntax '()' is (at least for now) not supported.

Please note the fundamental difference between

red is {}
red => {}

The first declares a feature red that defines a new unit type red, the second
declares a feature red with result type unit, i.e., a synonym for unit as in

red unit is {}

The memory required to store a value of unit type is 0 bits, so you can use
plenty without worrying about space constraints. The Fuzion code generators
typically will not generate any code for returning or assigning a value of unit
type, so these are very efficient as well.

void -- type with no values

NOTE: For a counterpart to void in C, Java, etc., see unit.fz

It is impossible to create any values of this type, consequently, it is impossible
to assign anything to a field of void type.

If used as the type of an argument field for a feature, the feature can never be
called since no value assignable to that argument could ever be produced. This
produces an absurd feature.

If used as the result type of a routine, the routine can never return.

void is the result type of the endless loop

do { <loop body> }

If used as the result type of a field, the field can never be assigned a value,
since no such value can be produced, and the field can never be read since it
remains not initialized forever.

Type void is assignable to all other types, e.g, we can assign void to a value
of type i32:

i i32 := exit 1

Since no value of type void can ever be produced, the assignment is dead code that
will be removed by the fuzion implementation.

Type void may be used as an actual generic argument for a generic feature. If this
is done, it will turn all features that have arguments of that type into absurd
features. Also, this will ensure that any feature that produces a result of that
type to never return a result (typically to not be callable in the first place as
well). An example could be a stack of capacity zero: stack void 0 with an
absurd

stack.push(void)

and a pop function with a precondition that is always false

pop void

The memory required to store a value of void type is not defined since these
values do not exist. The Fuzion code generators typically will not generate
any code for features receiving arguments of void type or for code following
a feature call that returns void.

yak -- shortcut for io.out.print

A handy shortcut for io.out.print, output string representation of
an object, do not add a line break at the end.

The term 'yak' was taken from the expression 'Yakety Yak' as in the
song by The Coasters.