PHP Algorithm class

English version

Clase con algoritmos para resolver y mostrar secuencias matemáticas.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Uso
• Tests
• Tareas pendientes
• Contribuir
• Repositorio
• Licencia
• Copyright

Requisitos

Esta clase es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Instalación

La mejor forma de instalar esta extensión es a través de Composer.

Para instalar PHP Algorithm library, simplemente escribe:

$ composer require Josantonius/Algorithm

El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente puedes utilizar:

$ composer require Josantonius/Algorithm --prefer-source

También puedes clonar el repositorio completo con Git:

$ git clone https://github.com/Josantonius/PHP-Algorithm.git

O instalarlo manualmente:

Descargar Algorithm.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Algorithm/master/src/Algorithm.php

Métodos disponibles

- Imprimir secuencia "Look-and-Say":

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

| Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $lastSequence | Valor inicial para iniciar la secuencia | int | No | 1 | | $maxLines | Número máximo de líneas a mostrar | int | No | 15 |

# Return (string) ? Secuencia.

Cómo empezar

Para utilizar esta clase con Composer:

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

use Josantonius\Algorithm\Algorithm;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/Algorithm.php';

use Josantonius\Algorithm\Algorithm;

Uso

Ejemplo de uso para esta clase:

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

Para ejecutar las pruebas necesitarás Composer y seguir los siguientes pasos:

$ git clone https://github.com/Josantonius/PHP-Algorithm.git

$ cd PHP-Algorithm

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de estándares de código PSR2 con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificación:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

? Tareas pendientes

• [ ] Añadir nueva funcionalidad.
• [ ] Mejorar pruebas.
• [ ] Mejorar documentación.
• [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Contribuir

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

• Fork and clone.
• Ejecuta el comando `composer install` para instalar dependencias. Esto también instalará las dependencias de desarrollo.
• Ejecuta el comando `composer fix` para estandarizar el código.
• Ejecuta las pruebas.
• Crea una nueva rama (branch), commit, push y envíame un pull request.

Repositorio

La estructura de archivos de este repositorio se creó con PHP-Skeleton.

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2017 - 2018 Josantonius, josantonius.com

Si te ha resultado útil, házmelo saber :wink:

Puedes contactarme en Twitter o a través de mi correo electrónico.