PHP Algorithm class

Versión en español

Class with algorithms to solve and display mathematical sequences.

• Requirements
• Installation
• Available Methods
• Quick Start
• Usage
• Tests
• TODO
• Contribute
• Repository
• License
• Copyright

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

? TODO

• [ ] Add new feature.
• [ ] Improve tests.
• [ ] Improve documentation.
• [ ] Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

• Fork and clone.
• Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
• Run the command `composer fix` to excute code standard fixers.
• Run the tests.
• Create a branch, commit, push and send me a pull request.

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2017 - 2018 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.