ext-ds.stub

<?php

namespace Ds;

use ArrayAccess;
use Countable;
use JsonSerializable;
use OutOfBoundsException;
use OutOfRangeException;
use Traversable;
use UnderflowException;

/**
 * @template-covariant TKey
 * @template-covariant TValue
 * @extends Traversable<TKey, TValue>
 */
interface Collection extends Traversable, Countable, JsonSerializable
{
	/**
	 * @return Collection<TKey, TValue>
	 */
	public function copy();

	/**
	 * @return array<TKey, TValue>
	 */
	public function toArray(): array;
}

/**
 * @template TValue
 * @implements Sequence<TValue>
 */
final class Deque implements Sequence
{
	/**
	 * @param iterable<TValue> $values
	 */
	public function __construct(iterable $values = [])
	{
	}

	/**
	 * @return Deque<TValue>
	 */
	public function copy()
	{
	}

	/**
	 * @template TValue2
	 * @param iterable<TValue2> $values
	 * @return Deque<TValue|TValue2>
	 */
	public function merge(iterable $values): Deque
	{
	}

	/**
	 * @param (callable(TValue): bool)|null $callback
	 * @return Deque<TValue>
	 */
	public function filter(callable $callback = null): Deque
	{
	}

	/**
	 * @template TNewValue
	 * @param callable(TValue): TNewValue $callback
	 * @return Deque<TNewValue>
	 */
	public function map(callable $callback): Deque
	{
	}

	/**
	 * @return Deque<TValue>
	 */
	public function reversed(): Deque
	{
	}

	/**
	 * @return Deque<TValue>
	 */
	public function slice(int $offset, ?int $length = null): Deque
	{
	}
}

/**
 * @template TKey
 * @template TValue
 * @implements Collection<TKey, TValue>
 * @implements ArrayAccess<TKey, TValue>
 */
final class Map implements Collection, ArrayAccess
{
	/**
	 * @param iterable<TKey, TValue> $values
	 */
	public function __construct(iterable $values = [])
	{
	}

	/**
	 * @return Map<TKey, TValue>
	 */
	public function copy(): Map
	{
	}

	/**
	 * @param callable(TKey, TValue): TValue $callback
	 * @return void
	 */
	public function apply(callable $callback)
	{
	}

	/**
	 * @return Pair<TKey, TValue>
	 * @throws UnderflowException
	 */
	public function first(): Pair
	{
	}

	/**
	 * @return Pair<TKey, TValue>
	 * @throws UnderflowException
	 */
	public function last(): Pair
	{
	}

	/**
	 * @return Pair<TKey, TValue>
	 * @throws OutOfRangeException
	 */
	public function skip(int $position): Pair
	{
	}

	/**
	 * @template TKey2
	 * @template TValue2
	 * @param iterable<TKey2, TValue2> $values
	 * @return Map<TKey|TKey2, TValue|TValue2>
	 */
	public function merge(iterable $values): Map
	{
	}

	/**
	 * @template TKey2
	 * @template TValue2
	 * @param Map<TKey2, TValue2> $map
	 * @return Map<TKey&TKey2, TValue>
	 */
	public function intersect(Map $map): Map
	{
	}

	/**
	 * @template TValue2
	 * @param Map<TKey, TValue2> $map
	 * @return Map<TKey, TValue>
	 */
	public function diff(Map $map): Map
	{
	}

	/**
	 * @param TKey $key
	 */
	public function hasKey($key): bool
	{
	}

	/**
	 * @param TValue $value
	 */
	public function hasValue($value): bool
	{
	}

	/**
	 * @param (callable(TKey, TValue): bool)|null $callback
	 * @return Map<TKey, TValue>
	 */
	public function filter(callable $callback = null): Map
	{
	}

	/**
	 * @template TDefault
	 * @param TKey $key
	 * @param TDefault $default
	 * @return TValue|TDefault
	 * @throws OutOfBoundsException
	 */
	public function get($key, $default = null)
	{
	}

	/**
	 * @return Set<TKey>
	 */
	public function keys(): Set
	{
	}

	/**
	 * @template TNewValue
	 * @param callable(TKey, TValue): TNewValue $callback
	 * @return Map<TKey, TNewValue>
	 */
	public function map(callable $callback): Map
	{
	}

	/**
	 * @return Sequence<Pair<TKey, TValue>>
	 */
	public function pairs(): Sequence
	{
	}

	/**
	 * @param TKey $key
	 * @param TValue $value
	 * @return void
	 */
	public function put($key, $value)
	{
	}

	/**
	 * @param iterable<TKey, TValue> $values
	 * @return void
	 */
	public function putAll(iterable $values)
	{
	}

	/**
	 * @template TCarry
	 * @param callable(TCarry, TKey, TValue): TCarry $callback
	 * @param TCarry $initial
	 * @return TCarry
	 */
	public function reduce(callable $callback, $initial = null)
	{
	}

	/**
	 * @template TDefault
	 * @param TKey $key
	 * @param TDefault $default
	 * @return TValue|TDefault
	 * @throws \OutOfBoundsException
	 */
	public function remove($key, $default = null)
	{
	}

	/**
	 * @return Map<TKey, TValue>
	 */
	public function reversed(): Map
	{
	}

	/**
	 * @return Map<TKey, TValue>
	 */
	public function slice(int $offset, ?int $length = null): Map
	{
	}

	/**
	 * @param (callable(TValue, TValue): int)|null $comparator
	 * @return void
	 */
	public function sort(callable $comparator = null)
	{
	}

	/**
	 * @param (callable(TValue, TValue): int)|null $comparator
	 * @return Map<TKey, TValue>
	 */
	public function sorted(callable $comparator = null): Map
	{
	}

	/**
	 * @param (callable(TKey, TKey): int)|null $comparator
	 * @return void
	 */
	public function ksort(callable $comparator = null)
	{
	}

	/**
	 * @param (callable(TKey, TKey): int)|null $comparator
	 * @return Map<TKey, TValue>
	 */
	public function ksorted(callable $comparator = null): Map
	{
	}

	/**
	 * @return array<TKey, TValue>
	 */
	public function toArray(): array
	{
	}

	/**
	 * @return Sequence<TValue>
	 */
	public function values(): Sequence
	{
	}

	/**
	 * @template TKey2
	 * @template TValue2
	 * @param Map<TKey2, TValue2> $map
	 * @return Map<TKey|TKey2, TValue|TValue2>
	 */
	public function union(Map $map): Map
	{
	}

	/**
	 * @template TKey2
	 * @template TValue2
	 * @param Map<TKey2, TValue2> $map
	 * @return Map<TKey|TKey2, TValue|TValue2>
	 */
	public function xor(Map $map): Map
	{
	}
}

/**
 * @template-covariant TKey
 * @template-covariant TValue
 */
final class Pair implements JsonSerializable
{
	/**
	 * @var TKey
	 */
	public $key;

	/**
	 * @var TValue
	 */
	public $value;

	/**
	 * @param TKey $key
	 * @param TValue $value
	 */
	public function __construct($key = null, $value = null)
	{
	}

	/**
	 * @return Pair<TKey, TValue>
	 */
	public function copy(): Pair
	{
	}
}

/**
 * @template TValue
 * @extends Collection<int, TValue>
 * @extends ArrayAccess<int, TValue>
 */
interface Sequence extends Collection, ArrayAccess
{
	/**
	 * @param callable(TValue): TValue $callback
	 * @return void
	 */
	public function apply(callable $callback);

	/**
	 * @return Sequence<TValue>
	 */
	public function copy();

	/**
	 * @param TValue ...$values
	 */
	public function contains(...$values): bool;

	/**
	 * @param (callable(TValue): bool)|null $callback
	 * @return Sequence<TValue>
	 */
	public function filter(callable $callback = null);

	/**
	 * @param TValue $value
	 * @return int|false
	 */
	public function find($value);

	/**
	 * @return TValue
	 * @throws \UnderflowException
	 */
	public function first();

	/**
	 * @return TValue
	 * @throws \OutOfRangeException
	 */
	public function get(int $index);

	/**
	 * @param TValue ...$values
	 * @throws \OutOfRangeException
	 * @return void
	 */
	public function insert(int $index, ...$values);

	/**
	 * @param string $glue
	 * @return string
	 */
	public function join(string $glue = null): string;

	/**
	 * @return TValue
	 * @throws \UnderflowException
	 */
	public function last();

	/**
	 * @template TNewValue
	 * @param callable(TValue): TNewValue $callback
	 * @return Sequence<TNewValue>
	 */
	public function map(callable $callback);

	/**
	 * @template TValue2
	 * @param iterable<TValue2> $values
	 * @return Sequence<TValue|TValue2>
	 */
	public function merge(iterable $values);

	/**
	 * @return TValue
	 * @throws \UnderflowException
	 */
	public function pop();

	/**
	 * @param TValue ...$values
	 * @return void
	 */
	public function push(...$values);

	/**
	 * @template TCarry
	 * @param callable(TCarry, TValue): TCarry $callback
	 * @param TCarry $initial
	 * @return TCarry
	 */
	public function reduce(callable $callback, $initial = null);

	/**
	 * @return TValue
	 * @throws \OutOfRangeException
	 */
	public function remove(int $index);

	/**
	 * @return Sequence<TValue>
	 */
	public function reversed();

	/**
	 * @param TValue $value
	 * @throws \OutOfRangeException
	 * @return void
	 */
	public function set(int $index, $value);

	/**
	 * @return TValue
	 * @throws \UnderflowException
	 */
	public function shift();

	/**
	 * @return Sequence<TValue>
	 */
	public function slice(int $index, ?int $length = null);

	/**
	 * @param (callable(TValue, TValue): int)|null $comparator
	 * @return void
	 */
	public function sort(callable $comparator = null);

	/**
	 * @param (callable(TValue, TValue): int)|null $comparator
	 * @return Sequence<TValue>
	 */
	public function sorted(callable $comparator = null);

	/**
	 * @param TValue ...$values
	 * @return void
	 */
	public function unshift(...$values);
}


/**
 * @template TValue
 * @implements Sequence<TValue>
 */
final class Vector implements Sequence
{
	/**
	 * @param iterable<TValue> $values
	 */
	public function __construct(iterable $values = [])
	{
	}

	/**
	 * @return Vector<TValue>
	 */
	public function copy()
	{
	}

	/**
	 * @return Vector<TValue>
	 */
	public function reversed(): Vector
	{
	}

	/**
	 * @return Vector<TValue>
	 */
	public function slice(int $offset, ?int $length = null): Vector
	{
	}

	/**
	 * @param (callable(TValue, TValue): int)|null $comparator
	 * @return Vector<TValue>
	 */
	public function sorted(callable $comparator = null): Vector
	{
	}

	/**
	 * @param (callable(TValue): bool)|null $callback
	 * @return Vector<TValue>
	 */
	public function filter(callable $callback = null): Vector
	{
	}

	/**
	 * @template TNewValue
	 * @param callable(TValue): TNewValue $callback
	 * @return Vector<TNewValue>
	 */
	public function map(callable $callback): Vector
	{
	}

	/**
	 * @template TValue2
	 * @param iterable<TValue2> $values
	 * @return Vector<TValue|TValue2>
	 */
	public function merge(iterable $values): Vector
	{
	}
}

/**
 * @template TValue
 * @implements Collection<int, TValue>
 * @implements ArrayAccess<int, TValue>
 */
final class Set implements Collection, ArrayAccess
{
	/**
	 * @param iterable<TValue> $values
	 */
	public function __construct(iterable $values = [])
	{
	}

	/**
	 * @param TValue ...$values
	 */
	public function add(...$values): void
	{
	}

	/**
	 * @param TValue ...$values
	 */
	public function contains(...$values): bool
	{
	}

	/**
	 * @return Set<TValue>
	 */
	public function copy(): Set
	{
	}

	/**
	 * @template TValue2
	 * @param Set<TValue2> $set
	 * @return Set<TValue>
	 */
	public function diff(Set $set): Set
	{
	}

	/**
	 * @param (callable(TValue): bool)|null $callback
	 * @return Set<TValue>
	 */
	public function filter(callable $callback = null): Set
	{
	}

	/**
	 * @return TValue
	 * @throws \UnderflowException
	 */
	public function first()
	{
	}

	/**
	 * @return TValue
	 * @throws \OutOfRangeException
	 */
	public function get(int $index)
	{
	}

	/**
	 * @template TValue2
	 * @param Set<TValue2> $set
	 * @return Set<TValue&TValue2>
	 */
	public function intersect(Set $set): Set
	{
	}

	/**
	 * @return TValue
	 * @throws \UnderflowException
	 */
	public function last()
	{
	}

	/**
	 * @template TNewValue
	 * @param callable(TValue): TNewValue $callback
	 * @return Set<TNewValue>
	 */
	public function map(callable $callback): Set
	{
	}

	/**
	 * @template TValue2
	 * @param iterable<TValue2> $values
	 * @return Set<TValue|TValue2>
	 */
	public function merge(iterable $values): Set
	{
	}

	/**
	 * @template TCarry
	 * @param callable(TCarry, TValue): TCarry $callback
	 * @param TCarry $initial
	 * @return TCarry
	 */
	public function reduce(callable $callback, $initial = null)
	{
	}

	/**
	 * @param TValue ...$values
	 */
	public function remove(...$values): void
	{
	}

	/**
	 * @return Set<TValue>
	 */
	public function reversed(): Set
	{
	}

	/**
	 * @return Set<TValue>
	 */
	public function slice(int $index, ?int $length = null): Set
	{
	}

	/**
	 * @param (callable(TValue, TValue): int)|null $comparator
	 */
	public function sort(callable $comparator = null): void
	{
	}

	/**
	 * @param (callable(TValue, TValue): int)|null $comparator
	 * @return Set<TValue>
	 */
	public function sorted(callable $comparator = null): Set
	{
	}

	/**
	 * @return list<TValue>
	 */
	public function toArray(): array
	{
	}

	/**
	 * @template TValue2
	 * @param Set<TValue2> $set
	 * @return Set<TValue|TValue2>
	 */
	public function union(Set $set): Set
	{
	}

	/**
	 * @template TValue2
	 * @param Set<TValue2> $set
	 * @return Set<TValue|TValue2>
	 */
	public function xor(Set $set): Set
	{
	}
}

/**
 * @template TValue
 * @implements Collection<int, TValue>
 * @implements ArrayAccess<int, TValue>
 */
final class Stack implements Collection, ArrayAccess
{
	/**
	 * @param iterable<TValue> $values
	 */
	public function __construct(iterable $values = [])
	{
	}

	/**
	 * @return Stack<TValue>
	 */
	public function copy(): Stack
	{
	}

	/**
	 * @return TValue
	 * @throws UnderflowException
	 */
	public function peek()
	{
	}

	/**
	 * @return TValue
	 * @throws UnderflowException
	 */
	public function pop()
	{
	}

	/**
	 * @param TValue ...$values
	 * @return void
	 */
	public function push(...$values): void
	{
	}

	/**
	 * @return list<TValue>
	 */
	public function toArray(): array
	{
	}
}

/**
 * @template TValue
 * @implements Collection<int, TValue>
 * @implements ArrayAccess<int, TValue>
 */
final class Queue implements Collection, ArrayAccess
{
	/**
	 * @param iterable<TValue> $values
	 */
	public function __construct(iterable $values = [])
	{
	}

	/**
	 * @return Queue<TValue>
	 */
	public function copy(): Queue
	{
	}

	/**
	 * @return TValue
	 * @throws UnderflowException
	 */
	public function peek()
	{
	}

	/**
	 * @return TValue
	 * @throws UnderflowException
	 */
	public function pop()
	{
	}

	/**
	 * @param TValue ...$values
	 */
	public function push(...$values): void
	{
	}

	/**
	 * @return list<TValue>
	 */
	public function toArray(): array
	{
	}
}

/**
 * @template TValue
 * @implements Collection<int, TValue>
 */
final class PriorityQueue implements Collection
{
	/**
	 * @return PriorityQueue<TValue>
	 */
	public function copy(): PriorityQueue
	{
	}

	/**
	 * @return TValue
	 * @throws UnderflowException
	 */
	public function peek()
	{
	}

	/**
	 * @return TValue
	 * @throws UnderflowException
	 */
	public function pop()
	{
	}

	/**
	 * @param TValue $value
	 */
	public function push($value, int $priority): void
	{
	}

	/**
	 * @return list<TValue>
	 */
	public function toArray(): array
	{
	}
}