routine first

Documentation for routine first assembled from the following types:

class Any

From Any

(Any) method first

Defined as:

multi method first(Bool:D $t)
multi method first(Regex:D $test:$end*%a)
multi method first(Callable:D $test:$end*%a is copy)
multi method first(Mu $test:$end*%a)
multi method first(:$end*%a)
multi sub first(Bool:D $t|)
multi sub first(Mu $test+values*%a)

In general, coerces the invocant to a list by applying its .list method and uses List.first on it.

However, there are several different methods, and they have (slightly) different behavior. Using a Bool as the argument will always return a Failure. Using it as a subroutine is equivalent to using it as a method with the second argument as the object.

The form that uses a $test will return the first element that smartmatches it, starting from the end if :end is used.

say (3..33).first;           # OUTPUT: «3␤» 
say (3..33).first(:end);     # OUTPUT: «33␤» 
say (⅓,⅔…30).first0xF );   # OUTPUT: «15␤» 
say first 0xF, (⅓,⅔…30);     # OUTPUT: «15␤» 
say (3..33).first( /\d\d/ ); # OUTPUT: «10␤» 

The third and fourth example use the Mu $test forms which smartmatches and returns the first element that does. The last example uses as a test a regex for numbers with two figures, and thus the first that meets that criterion is number 10. This last form uses the Callable multi:

say (⅓,⅔…30).first* %% 11:end:kv ); # OUTPUT: «(65 22)␤» 

Besides, starts from the :end and returns the :kv in a list; the key in this case is simply the position it occupies in the Seq.

class List

From List

(List) routine first

Defined as:

sub    first(Mu $matcher*@elems:$k:$kv:$p:$end)
method first(List:D:  Mu $matcher?:$k:$kv:$p:$end)

Returns the first item of the list which smartmatches against $matcher, returns Nil when no values match. The optional named parameter :end indicates that the search should be from the end of the list, rather than from the start.


say (122/742300).first: * > 5;                  # OUTPUT: «42␤» 
say (122/742300).first: * > 5:end;            # OUTPUT: «300␤» 
say ('hello'122/742'world').first: Complex;   # OUTPUT: «Nil␤» 

The optional named parameters :k, :kv, :p provide the same functionality as on slices:

Return the index value of the matching element. Index is always counted from the beginning of the list, regardless of whether the :end named parameter is specified or not.

Return both the index and matched element.

Return the index and the matched element as a Pair.


say (122/742300).first: * > 5:k;        # OUTPUT: «2␤» 
say (122/742300).first: * > 5:p;        # OUTPUT: «2 => 42␤» 
say (122/742300).first: * > 5:kv:end# OUTPUT: «(3 300)␤» 

In method form, the $matcher can be omitted, in which case the first available item (or last if :end is set) will be returned. See also head and tail methods.