Fuzion Logo
fuzion-lang.dev — The Fuzion Language Portal
»

float

float

:
numeric
 is
[Contains abstract features]
float -- floating point values


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

Constructors

:
Any
 is
[Inherited from  numeric]
[Contains abstract features]
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|)|`.

Functions

 => 
numeric.this
[Inherited from  numeric]
[Contains abstract features]
absolute value
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
float.this
[Contains abstract features]
 => 
i32
[Contains abstract features]
convert a float value to i32 dropping any fraction.
the value must be in the range of i32
 => 
i64
[Abstract feature]
[Contains abstract features]
convert a float value to i64 dropping any fraction.
the value must be in the range of i64
 => 
String
[Inherited from  Any]
[Contains abstract features]
create a String from this instance. Unless redefined, `a.as_string` will
create `"instance[T]"` where `T` is the dynamic type of `a`
 => 
u8
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
this numeric value as an u8
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
float.this
[Contains abstract features]
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
float.this
[Contains abstract features]
 => 
float.this
[Contains abstract features]
ceiling: the smallest integer greater or equal to this
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
Type
[Inherited from  Any]
[Contains abstract features]
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.
 => 
float.this
[Abstract feature]
[Contains abstract features]
the `val`-th power of ℇ
i.e. ℇᵛᵃˡ
 => 
i32
[Abstract feature]
[Contains abstract features]
the normalized exponent of this float
 => 
i32
[Abstract feature]
[Contains abstract features]
the biased exponent of this float
 => 
bool
[Contains abstract features]
does this float value fit into an i64? This is redefined by children
of float that support `as_i64`.
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
does this numeric value fit into an u8? This is redefined by children
of numeric that support `as_u8`.
 => 
float.this
[Contains abstract features]
floor: the greatest integer lower or equal to this
 => 
float.this
[Abstract feature]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
basic operations: 'infix %' (division remainder)
(other numeric.this)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
basic operations: 'infix *' (multiplication)
(other numeric.this)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
basic operations: 'infix **' (exponentiation)
(other numeric.this)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
option numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
(other numeric.this)
 => 
option numeric.this
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
basic operations: 'infix +' (addition)
(other numeric.this)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
option numeric.this
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
basic operations: 'infix -' (subtraction)
(other numeric.this)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
option numeric.this
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Contains abstract features]
(other numeric.this)
 => 
numeric.this
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
basic operations: 'infix /' (division)
(other numeric.this)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
 => 
bool
[Abstract feature]
[Contains abstract features]
is not a number?
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
 => 
bool
[Abstract feature]
[Contains abstract features]
is the bit denoting the sign of the number set?
this is different from smaller than zero since
there is +0, -0, NaN, etc. in floating point numbers.
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
 => 
float.this
[Abstract feature]
[Contains abstract features]
logarithm with base ℇ
(base float.this)
 => 
float.this
[Contains abstract features]
logarithm with base `base`
 => 
u64
[Abstract feature]
[Contains abstract features]
the normalized mantissa of this float
 => 
String
[Inherited from  Any]
[Contains abstract features]
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.
 => 
numeric.this
[Inherited from  numeric]
[Contains abstract features]
basic operations: 'prefix +' (identity)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
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.
 => 
numeric.this
[Inherited from  numeric]
[Contains abstract features]
basic operations: 'prefix -' (negation)
 => 
bool
[Inherited from  numeric]
[Contains abstract features]
 => 
option numeric.this
[Inherited from  numeric]
[Contains abstract features]
overflow checking operations
 => 
numeric.this
[Inherited from  numeric]
[Contains abstract features]
saturating operations
 => 
float.this
[Contains abstract features]
round floating point number
ties to away (0.5 => 1; -0.5 => -1; etc.)

NYI: PERFORMANCE: this could be made faster, see here:
https://cs.opensource.google/go/go/+/refs/tags/go1.18.1:src/math/floor.go;l=79
 => 
i32
[Inherited from  numeric]
[Contains abstract features]
sign function resulting in `-1`/`0`/`+1` depending on whether `numeric.this`
is less than, equal or greater than zero
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
float.this
[Contains abstract features]
square root alias
 => 
float.this
[Abstract feature]
[Contains abstract features]
square root
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
float.this
[Abstract feature]
[Contains abstract features]
 => 
bool
[Abstract feature]
[Contains abstract features]
true when the absolute value
is smaller than 0.001
or greater than 9_999_999

Type Functions

 => 
String
[Inherited from  Type]
[Contains abstract features]
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:

(y float.this.type, x float.this.type)
 => 
float.this.type
[Abstract feature]
[Contains abstract features]
 => 
i32
[Abstract feature]
[Contains abstract features]
number of bytes required to store this value
 => 
Type
[Inherited from  Type]
[Contains abstract features]
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:

 => 
float.this.type
[Abstract feature]
[Contains abstract features]
(a property.orderable.this.type, b property.orderable.this.type)
 => 
bool
[Inherited from  orderable]
[Contains abstract features]
equality implements the default equality relation for values of this type.

This relation must be

- reflexive (equality a a),
- symmetric (equality a b = equality b a), and
- transitive ((equality a b && equality b c) : equality a c).

result is true iff 'a' is considered to represent the same abstract value
as 'b'.
 => 
i32
[Abstract feature]
[Contains abstract features]
number of bits used for exponent
 => 
interval i32
[Contains abstract features]
(val i64)
 => 
float.this.type
[Abstract feature]
[Contains abstract features]
convert an i64 value to a floating point value

if the value cannot be represented exactly, the result is either
the nearest higher or nearest lower value
(v u32)
 => 
numeric.this.type
[Inherited from  numeric]
[Contains abstract features]
the value corresponding to v in whatever integer implementation we have,
maximum in case of overflow
(a property.hashable.this.type)
 => 
u64
[Inherited from  hashable]
[Abstract feature]
[Contains abstract features]
create hash code for this instance

This should satisfy the following condition:

(T.equality a b) : (T.hash_code a = T.hash_code b)
 => 
float.this.type
[Contains abstract features]
infinity
(T 
type
)
 => 
bool
[Inherited from  Type]
[Contains abstract features]
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
same
pre T : property.equatable
=>
a = b

or

val(n T) is

# check if T is numeric, if so
# return true if n > zero,
# return nil if T is not numeric
#
more_than_zero option bool =>
if T : numeric then
n > T.zero
else
nil
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
(a property.partially_orderable.this.type, b property.partially_orderable.this.type)
 => 
bool
[Inherited from  partially_orderable]
[Abstract feature]
[Contains abstract features]
does a come before b or is equal to b?
 => 
i32
[Contains abstract features]
the amount of bits that are used to encode the mantissa
 => 
float.this.type
[Abstract feature]
[Contains abstract features]
 => 
i32
[Abstract feature]
[Contains abstract features]
 => 
i32
[Abstract feature]
[Contains abstract features]
 => 
float.this.type
[Abstract feature]
[Contains abstract features]
 => 
String
[Inherited from  Type]
[Contains abstract features]
name of this type, including type parameters, e.g. 'option (list i32)'.
 => 
float.this.type
[Contains abstract features]
not a number
 => 
float.this.type
[Contains abstract features]
 => 
numeric.this.type
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
identity element for 'infix *'
 => 
float.this.type
[Contains abstract features]
 => 
String
[Inherited from  Type]
[Contains abstract features]
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:

 => 
Monoid numeric.this.type
[Inherited from  numeric]
[Contains abstract features]
monoid of numeric with infix * operation. Will create product of all elements
it is applied to.
 => 
Monoid numeric.this.type
[Inherited from  numeric]
[Contains abstract features]
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.
 => 
float.this.type
[Contains abstract features]
non signaling not a number
 => 
i32
[Abstract feature]
[Contains abstract features]
number of bits used for mantissa,
including leading '1' that is not actually stored
 => 
i32
[Contains abstract features]
number of bits required to store this value
 => 
Monoid numeric.this.type
[Inherited from  numeric]
[Contains abstract features]
monoid of numeric with infix + operation. Will create sum of all elements it
is applied to.
 => 
Monoid numeric.this.type
[Inherited from  numeric]
[Contains abstract features]
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.
 => 
numeric.this.type
[Inherited from  numeric]
[Contains abstract features]
the constant '10' in whatever integer implementation we have, maximum in case of overflow
 => 
numeric.this.type
[Inherited from  numeric]
[Contains abstract features]
the constant '2' in whatever integer implementation we have, maximum in case of overflow
 => 
Type
[Inherited from  Any]
[Contains abstract features]
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`.
 => 
numeric.this.type
[Inherited from  numeric]
[Abstract feature]
[Contains abstract features]
identity element for 'infix +'
 => 
float.this.type
[Abstract feature]
[Contains abstract features]
pi 3.14...
 => 
float.this.type
[Abstract feature]
[Contains abstract features]
eulers number 2.72..
0.094dev (2025-06-18 15:08:51 GIT hash 89cffc23ae669b0898a5564fefbf793fcb8e5ca7 built by fridi@fzen)