☰
wrap_around
num.wrap_around
Value Constructors
absolute value using `|a|` built from a `prefix |` and `postfix |` as an operator
alias of `a.abs`
Due to the low precedence of `|`, this works also on expressions like `|a-b|`, even
with spaces `| a-b |`, `|a - b|`, `| a-b|` or `|a-b |`.
Nesting, however, does not work, e.g, `| - |a| |`, this requires parentheses `|(- |a|)|`.
NYI: CLEANUP: Due to #3081, we need `postfix |` as the first operation, should be
`prefix |` first
alias of `a.abs`
Due to the low precedence of `|`, this works also on expressions like `|a-b|`, even
with spaces `| a-b |`, `|a - b|`, `| a-b|` or `|a-b |`.
Nesting, however, does not work, e.g, `| - |a| |`, this requires parentheses `|(- |a|)|`.
NYI: CLEANUP: Due to #3081, we need `postfix |` as the first operation, should be
`prefix |` first
Functions
convert this to a decimal number in a string. If negative, add "-" as
the first character.
the first character.
convert this to a number using the given base. If negative, add "-" as
the first character.
the first character.
convert this to a number using the given base. If negative, add "-" as
the first character. Extend with leading "0" until the length is at
least len
the first character. Extend with leading "0" until the length is at
least len
create binary representation with given number of digits.
create decimal representation with given number of digits.
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.
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.
does this numeric value fit into an u8? This is redefined by children
of numeric that support `as_u8`.
of numeric that support `as_u8`.
greatest common divisor of this and b
note that this assumes zero to be divisible by any positive integer.
note that this assumes zero to be divisible by any positive integer.
create hexadecimal representation with given number of digits.
basic operations: 'infix %' (division remainder)
bitwise operations
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix *]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix *]
multiplication, with check for overflow
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix **]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix **]
exponentiation for positive exponent
'zero ** zero' is permitted and results in 'one'.
'zero ** zero' is permitted and results in 'one'.
§(other num.this.wrap_around.this):Any => num_option num.this.wrap_around.this [Redefinition of numeric.infix **?]
§(other num.this.wrap_around.this)
:
Any =>
num_option num.this.wrap_around.this [Redefinition of numeric.infix **?]
exponentiation with overflow checking semantics
'zero **? zero' is permitted and results in 'one'.
'zero **? zero' is permitted and results in 'one'.
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix **^]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix **^]
exponentiation with saturating semantics
'zero **^ zero' is permitted and results in 'one'.
'zero **^ zero' is permitted and results in 'one'.
exponentiation with wrap-around semantics
'zero **° zero' is permitted and results in 'one'.
'zero **° zero' is permitted and results in 'one'.
§(other num.this.wrap_around.this):Any => num_option num.this.wrap_around.this [Redefinition of numeric.infix *?]
§(other num.this.wrap_around.this)
:
Any =>
num_option num.this.wrap_around.this [Redefinition of numeric.infix *?]
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix *^]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix *^]
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix +]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix +]
addition, with check for overflow
§(other num.this.wrap_around.this):Any => num_option num.this.wrap_around.this [Redefinition of numeric.infix +?]
§(other num.this.wrap_around.this)
:
Any =>
num_option num.this.wrap_around.this [Redefinition of numeric.infix +?]
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix +^]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix +^]
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix -]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix -]
subtraction, with check for overflow
§(other num.this.wrap_around.this):Any => num_option num.this.wrap_around.this [Redefinition of numeric.infix -?]
§(other num.this.wrap_around.this)
:
Any =>
num_option num.this.wrap_around.this [Redefinition of numeric.infix -?]
§(other num.this.wrap_around.this):Any => num.this.wrap_around.this [Redefinition of numeric.infix -^]
§(other num.this.wrap_around.this)
:
Any =>
num.this.wrap_around.this [Redefinition of numeric.infix -^]
basic operations: 'infix /' (division)
preconditions used in 'numeric' for basic operations: true if the
operation is permitted for the given values
operation is permitted for the given values
create a fraction
shift operations
create a fraction via unicode fraction slash \u2044 '⁄ '
check if this type of wrap_around is bounded
wrap_arounds are assumed to be a bound set by default, so
this returns true unless redefined by an implementation
wrap_arounds are assumed to be a bound set by default, so
this returns true unless redefined by an implementation
create octal representation with given number of digits.
count the number of 1 bits in the binary representation of this
integer.
integer.
would addition wrap_around.this + other cause an overflow or underflow?
would exponentiation 'this ** other' cause an overflow?
would multiplication wrap_around.this * other cause an overflow or underflow?
would subtraction wrap_around.this - other cause an overflow or underflow?
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.
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.
preconditions for basic operations: true if the operation's result is
representable and defined for the given values
default implementations all return `true` such that children have to
redefine these only for partial operations such as those resulting in
an overflow or that are undefined like a division by zero for most
types.
representable and defined for the given values
default implementations all return `true` such that children have to
redefine these only for partial operations such as those resulting in
an overflow or that are undefined like a division by zero for most
types.
negation, with check for overflow
preconditions used in 'numeric' for basic operations: true if the
operation is permitted for the given values
operation is permitted for the given values
overflow checking operations
saturating operations
neg, add, sub, mul with wrap-around semantics
bitwise NOT
sign function resulting in `-1`/`0`/`+1` depending on whether `numeric.this`
is less than, equal or larger than zero
is less than, equal or larger than zero
would negation -wrap_around.this cause an overflow?
Value Types
absolute value using `|a|` built from a `prefix |` and `postfix |` as an operator
alias of `a.abs`
Due to the low precedence of `|`, this works also on expressions like `|a-b|`, even
with spaces `| a-b |`, `|a - b|`, `| a-b|` or `|a-b |`.
Nesting, however, does not work, e.g, `| - |a| |`, this requires parentheses `|(- |a|)|`.
NYI: CLEANUP: Due to #3081, we need `postfix |` as the first operation, should be
`prefix |` first
alias of `a.abs`
Due to the low precedence of `|`, this works also on expressions like `|a-b|`, even
with spaces `| a-b |`, `|a - b|`, `| a-b|` or `|a-b |`.
Nesting, however, does not work, e.g, `| - |a| |`, this requires parentheses `|(- |a|)|`.
NYI: CLEANUP: Due to #3081, we need `postfix |` as the first operation, should be
`prefix |` first
Type Features
returns the number in whose bit representation all bits are ones
string representation of this type to be used for debugging.
result has the form "Type of '<name>'", but this might change in the future
result has the form "Type of '<name>'", but this might change in the future
how many bytes does this integer use?
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.
endless hierarchy of types, so dynamic_type is redefined to just return
Type.type here.
equality
the value corresponding to v in whatever integer implementation we have,
maximum in case of overflow
maximum in case of overflow
create hash code for this instance
This should satisfy the following condition:
(T.equality a b) : (T.hash_code a = T.hash_code b)
This should satisfy the following condition:
(T.equality a b) : (T.hash_code a = T.hash_code b)
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
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
total order
name of this type, including type parameters, e.g. 'option (list i32)'.
monoid of numeric with infix * operation. Will create product of all elements
it is applied to.
it is applied to.
monoid of numeric with infix *^ operation. Will create product of all elements
it is applied to, stopping at max/min value in case of overflow.
it is applied to, stopping at max/min value in case of overflow.
monoid of numeric with infix + operation. Will create sum of all elements it
is applied to.
is applied to.
monoid of numeric with infix +^ operation. Will create sum of all elements it
is applied to, stopping at max/min value in case of overflow.
is applied to, stopping at max/min value in case of overflow.
the constant '10' in whatever integer implementation we have, maximum in case of overflow
the constant '2' in whatever integer implementation we have, maximum in case of overflow
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`.
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`.
wrap_around is the abstract ancestor of integer numbers that have min and
max values and operations with wrap-around semantics.