1. trait
  2. SciPhp
  3. \
  4. NdArray
  5. \
  6. IndexTrait

IndexTrait

trait IndexTrait (View source)

Indexing methods for NdArray

Methods

mixed
offsetGet(string|int $index)

Get a view by index

NdArray
offsetSet(int|string $index, int|string $value)

Set a view by index

int|float|array
filterGet(array $filter, int $index, array|null $data = null)

Get values from an element or a range

void
filterSet(array $filter, int $index, array|null $data = null, int|float $value = null)

Assign values to an element or a range

array
indexFilter(array $matches)

Prepare filter values

array
filterRange(array $filter, int $index, int $count)

Get range definition

bool
offsetUnset(mixed $offset)

Remove a portion of the data array

bool
offsetExists(mixed $offset)

Check that an index is defined

Details

at line 22
final mixed offsetGet(string|int $index)

Get a view by index

Parameters

string|int $index

Return Value

mixed

at line 47
final NdArray offsetSet(int|string $index, int|string $value)

Set a view by index

Parameters

int|string $index
int|string $value

Return Value

NdArray

at line 70
final protected int|float|array filterGet(array $filter, int $index, array|null $data = null)

Get values from an element or a range

Parameters

array $filter
int $index
array|null $data

Return Value

int|float|array

at line 99
final protected void filterSet(array $filter, int $index, array|null $data = null, int|float $value = null)

Assign values to an element or a range

Parameters

array $filter
int $index
array|null $data
int|float $value

Return Value

void

at line 131
final protected array indexFilter(array $matches)

Prepare filter values

Parameters

array $matches

Return Value

array

at line 194
final protected array filterRange(array $filter, int $index, int $count)

Get range definition

Parameters

array $filter
int $index
int $count

Return Value

array

at line 236
final bool offsetUnset(mixed $offset)

Remove a portion of the data array

Parameters

mixed $offset

Return Value

bool

at line 246
final bool offsetExists(mixed $offset)

Check that an index is defined

Parameters

mixed $offset

Return Value

bool