Skip to content

docs: add draft for AbstractList documentation for Core-package #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThorstenSuckow merged 1 commit into from
May 29, 2023
Merged

docs: add draft for AbstractList documentation for Core-package #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions docs/packages/quant/core/AbstractList.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
id: abstractlist
title: AbstractList
slug: /packages/quant/core/abstractlist
---

Reference

## Definition
Namespace: `Quant\Core`

`AbstractList` Represents a strongly typed list with methods for manipulating and searching.

```php
class AbstractList<T>: \Quant\Core\Contract\Arrayable,
\Quant\Core\Contract\Equatable,
\ArrayAccess<int, T>,
\Iterator<int, T>,
\Countable
```

## Example

```php

#[Getter] #[Setter]
class Entity
{
use AccessorTrait;

public function __construct(private string $value)
{
}
}

class EntityList extends AbstractList {

public function getType(): string
{
return Entity::class;
}

protected function compareItems(mixed $a, mixed $b): bool
{
if (!($a instanceof Entity) && !($b instanceof Entity)) {
return false;
}

return $a->getValue() === $b->getValue();
}

}

$listA = new EntityList();
$listA[] = new Entity("1");
$listA[] = new Entity("1");

$listB = new EntityList();
$listB[] = new Entity("1");
$listB[] = new Entity("2");

$listA->equals($listB); // false

$listC = EntityList::make(new Entity("3"), new Entity("4"));

$listC->map(fn(Entity $item): Entity => $item->setValue("1"))->equals($listA); // true

$listB->peek()->getValue(); // "2"

$listC->findBy(fn (Entity $item): bool => $item->getValue() === "a"); //null
$listC->findBy(fn (Entity $item): bool => $item->getValue() !== "a")->toArray(); //[listC[0], listC[1]]
```

## Remarks


## Methods