README

Constructs

Constructs provides simple data structures with a fluent api.

• Install
• Lists
  • ArrayList
  • LinkedList
• Stacks
  • ArrayStack
  • LinkedStack
• Queues
  • ArrayQueue
• Threes
  • ArrayHeap
  • SearchThree
• Helpers
  • toArray()
  • dump() & dumpAndDie()

🛠 Install

Just add this package to your composer project:

$ composer require opmvpc/constructs

Then import Constructs main class or individual classes in your code.

Lists

Available methods

public static function make(): ListContract;
public function size(): int;
public function contains($item): bool;
public function add($item): ListContract;
public function remove($item): ListContract;
public function get(int $i);
public function toArray(): array;

ArrayList

Usage

$list = Construct::arrayList()
    ->add(4)
    ->add(2)
    ->remove(4)
    ->add(6);

LinkedList

Usage

$list = Construct::linkedList()
    ->add(4)
    ->add(2)
    ->add(6);

Complexity

Stacks

Available methods

public static function make(): StackContract;
public function isEmpty(): bool;
public function push($item): StackContract;
public function pop(): StackContract;
public function top();
public function toArray(): array;

ArrayStack

Usage

$stack = Construct::linkedStack()
    ->push(4)
    ->push(2)
    ->pop();

LinkedStack

Usage

$stack = Construct::linkedStack()
    ->push(4)
    ->push(2)
    ->pop();

Complexity

Queues

Available methods

public static function make(): QueueContract;
public function isEmpty(): bool;
public function enqueue($item): QueueContract;
public function dequeue();
public function peek();
public function toArray(): array;

ArrayQueue

Usage

$queue = Construct::linkedQueue()
    ->enqueue(4)
    ->enqueue(2)
    ->dequeue()
    ->enqueue(6);

Complexity

Threes

ArrayHeap

Available methods

public static function make(): ThreeContract;
public function size(): int;
public function add($item): ThreeContract;
public function remove($item): ThreeContract;
public function get(int $i): SimpleNode;
public function toArray(): array;

Usage

$heap = Construct::arrayHeap()
    ->add(4)
    ->add(2)
    ->remove(2)
    ->add(6);

Complexity

LinkedSearchThree

Available methods

public static function make(): ThreeContract;
public function root(): Leaf;
public function min(): Leaf;
public function max(): Leaf;
public function search($key): Leaf;
public function insert($index, $item): ThreeContract;
public function toArray(): array;
public function keysArray(): array;

Usage

$three = Construct::arrayHeap()
    ->insert(4, 'world')
    ->insert(2, 'hello');

    $three->min();
    $three->max();

Algorithmic Complexity

Space Complexity

Helpers

toArray()

You can get an array representation of the current structure with the toArray() method.

$array = Construct::linkedList()
    ->add(4)
    ->toArray();

dump() 🚽 & dumpAndDie() ☠

Constructs uses the var_dumper Symfony component. You can use the dump() method on your structures.

$list = Construct::linkedList()
    ->add(4)
    ->dump()
    ->remove(4)
    ->dump();

If you are more a "Dump and die" person, dumpAndDie() method is also available.

$list = Construct::linkedList()
    ->add(4)
    ->add(2)
    ->remove(4)
    ->add(6)
    ->dumpAndDie();