class Mix

class Mix does Mixy { }

An immutable collection of weighted values. The weights are accessable via the { } postcircumfix. For a mutable collection, see MixHash.

# TODO: More useful example
{a => 1.3, b => 4.8, c => 8}.Mix<b> == 4.8 # True

sub mix

sub mix(*@args --> Mix)

Creates a new Mix from @args.

Type graph

Below you should see an imgage showing the type relations for Mix. If not, try the PNG version.

perl6-type-graph Mix Mix Any Any Mix->Any Mixy Mixy Mix->Mixy Mu Mu Any->Mu Associative Associative QuantHash QuantHash QuantHash->Associative Baggy Baggy Baggy->QuantHash Mixy->Baggy

Methods supplied by role Mixy

Mix does role Mixy, which provides the following methods:

method total

method total(--> Real)

Returns the sum of all the weights

mix('a','b','c','a','a','d').total == 6; # True
{a => 5.6, b => 2.4}.Mix.total == 8; # True

method new-fp

method new-fp(*@pairs --> Mixy)

Creates a new Mixy object from the pairs given. Where one might write:

{a => 5.6, b => 2.4}.Mix;

One could instead use:

Mix.new-fp((a => 5.6, b => 2.4));

method roll

method roll ($count = 1)

Similar to a Bag.roll, but with Real weights rather than integral ones.

Methods supplied by class Any

Mix inherits from class Any, which provides the following methods:

method ACCEPTS

multi method ACCEPTS(Any:D: Mu $other)

Returns True if $other === self (i.e. it checks object identity).

method any

Interprets the invocant as a list and creates an any-Junction from it.

method all

Interprets the invocant as a list and creates an all-Junction from it.

method one

Interprets the invocant as a list and creates an one-Junction from it.

method none

Interprets the invocant as a list and creates an none-Junction from it.

Methods supplied by class Mu

Mix inherits from class Mu, which provides the following methods:

method Str

multi method Str()   returns Str

Returns a string representation of the invocant, intended to be machine readable.

method clone

method clone(*%twiddles)

Creates a shallow clone of the invocant. If named arguments are passed to it, their values are used in every place where an attribute name matches the name of a named argument.

method new

multi method new(*%attrinit)

Default method for constructing (create + initialize) new objects of a class. This method expects only named arguments which are then used to initialize attributes with accessors of the same name.

Classes may provide their own new method to override this default.

method bless

method bless(*%attrinit) returns Mu:D

Lower-level object construction method than new.

Creates a new object of the same type as the invocant, uses the named arguments to initialize attributes, and returns the created object.

You can use this method when writing custom constructors:

class Point {
    has $.x;
    has $.y;
    multi method new($x, $y) {
        self.bless(:$x, :$y);
    }
}
my $p = Point.new(-1, 1);

(Though each time you write a custom constructor, remember that it makes subclassing harder).

method CREATE

method CREATE() returns Mu:D

Allocates a new object of the same type as the invocant, without initializing any attributes.

method print

multi method print() returns Bool:D

Prints value to $*OUT after stringification using .Str method without newline at end.

method say

multi method say() returns Bool:D

Prints value to $*OUT after stringification using .gist method with newline at end.

method ACCEPTS

multi method ACCEPTS(Mu:U: $other)

Performs a type check. Returns True if $other conforms to the invocant (which is always a type object or failure).

This is the method that is triggered on smart-matching against type objects, for example in if $var ~~ Int { ... }.

method WHICH

multi method WHICH() returns ObjAt:D

Returns an object of type ObjAt which uniquely identifies the object. Value types override this method which makes sure that two equivalent objects return the same return value from WHICH.