unit module Listicles:ver<1.0.0>:auth<masukomi (masukomi@masukomi.org)>;



A collection of helper methods to make working with Arrays a little easier.



use MONKEY-TYPING;

augment class Array {

	#|( Returns a new list without the first or last $count elements of the array depending on if count is positive or negative.
	)
	method drop(Int $count, Bool :$all_or_nothing

False


		 if $all_or_nothing {
			my $invalid = $count > 0
				?? ($count > self.elems)
				!! (($count * -1) > self.elems);
			die("Array doesn't have $count elements") if $invalid;
		 }
		 my $num_elements_needed = $count > 0 ?? $count !! $count * -1;
		 # return a copy
		 if $count == 0 {
			 return self.clone;
		 } elsif $num_elements_needed > self.elems {
			 return [];
		 }
		 # we know it's a subset now.

		 ($count > 0
		  ?? self[($count - 1)^..*]
		  !! self[0..(self.elems - $num_elements_needed - 1)]
		 ).Array
	}


	#|( Tests if the array includes the item passed in.
	 Set ducktyped to True for ducktyped matches.
	 For example "4" will match 4 with ducktyped matches.
	)
	method includes(Any $x, Bool :$ducktyped = False) returns Bool:D {
		return False if self.is-empty();
		if ! $x.isa(Nil) {
			my $y = self.first: * ~~ $x;
			return False if $y.isa(Nil);
			return (! $ducktyped) ?? $y.WHAT ~~ $x.WHAT !! True ;
		} else {
			loop (my $index = 0; $index < self.elems; $index++) {
				return True if self[$index].isa(Nil);
			}
		}
		False;
	}

	#| Tests if the array is empty
    method is-empty() returns Bool:D {
		self.elems == 0;
    }

	#|( Splits a Array into an array of arrays of the specified length (or smaller).
	If the array is not evenly divisble then the last array will contain the remainder.
	If only_perfect_splits is set to True it will throw an exception if the Array is not
	evenly divisible by $size.
	)
	method split-by(Int $size, Bool :$only_perfect_splits


		my @result = [];
		loop (my $index = 0; $index < self.elems; $index += $size ) {
			my $end = $index + ($size - 1);
			$end = self.elems - 1 if $end >= self.elems;

			@result.push(self[$index..$end].Array);
		}
		return @result;
	}


	#|( Take returns $count elements of the Array from the beginning
	or end depending on if $count is positive or negative. If there are fewer elements
	than $count it will return whatever is available. Set all_or_nothing to True
	and it will throw an exception if there are insufficient elements.
	)
	method take(Int $count, Bool :$all_or_nothing


		 # we know it's a subset now.
		 ($count > 0
		  ?? self[0..^$num_elements_needed]
		  !! self[(self.elems - $num_elements_needed )..(self.elems - 1)]
		 ).Array
	}

	#|( creates a hash with the stringified index of each element as its key. Set one_based to True to have it start the keys at 1 instead of 0.
	Example: ["foo", "bar"] -> {"0"=>"foo", "1"=>"bar"}
	)
	method to-hash(:$one_based

root

README

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Listicles

Listicles v1.0.0

Authors

License

Dependencies

Test Dependencies

Provides

Documentation