README

Translations: Español

Class with algorithms to solve and display mathematical sequences.

Requirements
Installation
Available Methods
Quick Start
Usage
Tests
Changelog
Contribution
Sponsor
License

Requirements

This class is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher...

Installation

The preferred way to install this extension is through Composer.

To install PHP Algorithm class, simply:

composer require josantonius/algorithm

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

composer require josantonius/algorithm --prefer-source

You can also clone the complete repository with Git:

git clone https://github.com/josantonius/php-algorithm.git

Or install it manually:

Download Algorithm.php:

wget https://raw.githubusercontent.com/josantonius/php-algorithm/master/src/Algorithm.php

Available Methods

Available methods in this class:

Print "Look-and-Say" sequence

Algorithm::lookAndSay($lastSequence, $maxLines);

Attribute	Description	Type	Required	Default
$lastSequence	Initial value to start the sequence	int	No	1
$maxLines	Maximum lines number to show	int	No	15

# Return (string) → Sequence.

Quick Start

To use this class with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Algorithm\Algorithm;

Or If you installed it manually, use it:

require_once __DIR__ . '/Algorithm.php';

use Josantonius\Algorithm\Algorithm;

Usage

Example of use for this class:

echo Algorithm::lookAndSay();

/*
1
11
21
1211
111221
312211
13112221
1113213211
31131211131221
13211311123113112211
11131221133112132113212221
3113112221232112111312211312113211
1321132132111213122112311311222113111221131221
11131221131211131231121113112221121321132132211331222113112211
311311222113111231131112132112311321322112111312211312111322212311322113212221
*/

echo Algorithm::lookAndSay(22, 5);

/*
22
22
22
22
22
*/

Tests

To run tests you just need composer and to execute the following:

git clone https://github.com/josantonius/php-algorithm.git

cd php-algorithm

composer install

Run unit tests with PHPUnit:

composer phpunit

Run PSR2 code standard tests with PHPCS:

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

composer phpmd

Run all previous tests:

composer tests

Changelog

Detailed changes for each release are documented in the release notes.

Contribution

Please make sure to read the Contributing Guide, before making a pull request, start a discussion or report a issue.

Thanks to all contributors to this project! ❤️

Sponsor

If you found this interesting, you can become my sponsor! 😊

License

This project is licensed under the MIT License.

josantonius / algorithm

Maintainers

Details