algorithm-spiralmatrix's Introduction

Algorithm::SpiralMatrix

Various Raku Sequences for spirals in matrix (two-dimensional arrays).

For overview see docs/test-output.md and docs/distance-variants.md.

Synopsis

use Algorithm::SpiralMatrix;

my $i = 1;
for square_distance(order => 'clockwise') -> ($x,$y) {
    say "{$i++} $x,$y";
    last if $i > 25;
}

will print

1 0,0
2 0,-1
3 1,0
4 0,1
5 -1,0
6 1,-1
8 -1,1
9 -1,-1
...
24 -2,2
25 -2,-2

Description

This module provides implementation of algorithms to generate various spiral sequences in matrix (two-dimensional array).

Installation

Rakudo Raku distribution contains zef. Use

zef install Algorithm::SpiralMatrix

If you have a local copy of this repository use

zef install .

in the module directory.

Support

Feel free to share your suggestions, patches or comment https://github.com/mj41/Algorithm-SpiralMatrix/issues.

Licence and Copyright

This is free software. Please see the LICENCE file.

algorithm-spiralmatrix's People

Contributors

Stargazers

Watchers

algorithm-spiralmatrix's Issues

Common snail variant is not implemented

See for example zero2cx/spiral-matrix (Python) and my
https://github.com/mj41/Algorithm-SpiralMatrix/blob/master/docs/snail-variants-even.png and https://github.com/mj41/Algorithm-SpiralMatrix/blob/master/docs/snail-variants-odd.png idea visualizations.

Tests will fail on next release of Rakudo (2021.10)

The reason for this is that rakudo/rakudo@a86ec91 fixed an issue with List.fmt, which is used by the test logic of this module. This causes test failures now.

I would suggest using using tests with is-deeply rather than depending on stringification.

Please let me know if you can find time to fix this before the 2021.10 release in a week. If not, I will try to find some time to create a PR to fix the issue.

Thank your for any time you can give to this. And thanks for a nice module as well! :-)