Rules / Types, classes & roles / basic

NumStr Reference

Dual value floating-point number and string

What it is #

Routines #

Signatures are reproduced from the documentation, including their declared return types. A routine listed here is part of the type's published interface; whether Raku++ implements it is a separate question, answered by the examples below.

method new #

method new(Num $i, Str $s)

The constructor requires both the Num and the Str value, when constructing one directly the values can be whatever is required:

method Num #

method Num

Returns the Num value of the NumStr.

method Numeric #

multi method Numeric(NumStr:D: --> Num:D)
multi method Numeric(NumStr:U: --> Num:D)

Returns Num:D.

The :D variant returns the numeric portion of the invocant. The :U variant issues a warning about using an uninitialized value in numeric context and then returns value 0e0.

method Real #

multi method Real(NumStr:D: --> Num:D)
multi method Real(NumStr:U: --> Num:D)

Returns Num:D.

The :D variant returns the numeric portion of the invocant. The :U variant issues a warning about using an uninitialized value in numeric context and then returns value 0e0.

infix C«===» #

multi infix:<===>(NumStr:D $a, NumStr:D $b)

NumStr Value identity operator. Returns True if the Num values of $a and $b are identical and their Str values are also identical. Returns False otherwise.

Examples, run three ways #

Every example below comes from the official documentation, together with the output that documentation asserts. Each was then executed by Rakudo and by Raku++ when this page was built. Where the three agree, one result is shown; where they do not, all three are — because which of them is wrong is exactly the information worth having.

1 doc-drift · 1 no-output · 1 ok

class NumStr is Allomorph is Num { }

Not executed: the documentation states no expected output for this example.

my $num-str = <42.1e0>;
say $num-str.^name;         # OUTPUT: «NumStr␤»

my Num $num = $num-str;     # OK!
my Str $str = $num-str;     # OK!

# ∈ operator cares about object identity
say 42e10 ∈ <42e10  55  1>; # OUTPUT: «False␤»
Output
NumStr
False

Documentation, Rakudo and Raku++ all agree.

my $f = NumStr.new(42.1e0, "forty two and a bit");
say +$f; # OUTPUT: «42.1␤»
say ~$f; # OUTPUT: «"forty two and a bit"␤»
Documentation
42.1
"forty two and a bit"
Rakudo
42.1
forty two and a bit
Raku++
42.1
forty two and a bit

Both engines agree; the documentation states something else. Trust the engines.