1. class
  2. SciPhp
  3. \
  4. NdArray

NdArray

final class NdArray extends Decorator (View source)

Base array

Traits

ArithmeticTrait
Arithmetic methods
AttributeTrait
Attribute methods for NdArray
BasicTrait
Basics for NdArray
IndexTrait
Indexing methods for NdArray
ShapeTrait
Shape methods for NdArray
VisitorTrait
Visitor methods

Properties

array $data Access data as a PHP array.
NdArray $T Permute the dimensions of an array.
int $ndim Number of dimensions of an array.
int $size Number of elements of an array.
array $shape Tuple of array dimensions.

Methods

NdArray
divide(NdArray|array|float|int $input)

Divide matrix by a given input, element-wise

from  ArithmeticTrait
NdArray
dot(NdArray|array|float|int $input)

Dot matrix with an input

from  ArithmeticTrait
NdArray
add(NdArray|array|float|int $input)

Add a matrix or a number

from  ArithmeticTrait
void
__set(string $name, mixed $value)

Attribute setter

from  AttributeTrait
int|array|NdArray
__get(string $name)

Generic getter

from  AttributeTrait
int
getSize()

Get the total number of elements of the array

from  AttributeTrait
array
getShape(int|float|array $data, array $shape)

Gets the dimensions of the array

from  ShapeTrait
NdArray
copy()

Create a copy

from  BasicTrait
mixed
offsetGet(string|int $index)

Get a view by index

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

Set a view by index

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

Get values from an element or a range

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

Assign values to an element or a range

from  IndexTrait
array
indexFilter(array $matches)

Prepare filter values

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

Get range definition

from  IndexTrait
bool
offsetUnset(mixed $offset)

Remove a portion of the data array

from  IndexTrait
bool
offsetExists(mixed $offset)

Check that an index is defined

from  IndexTrait
NdArray
ravel()

Flattens data array

from  ShapeTrait
NdArray
resize()

Resize array

from  ShapeTrait
NdArray
reshape()

Reshapes data

from  ShapeTrait
NdArray
walk(callable $func)

Walk on first dimension

from  VisitorTrait
NdArray
walk_recursive(callable $func)

Walk on last dimension

from  VisitorTrait
int|float
iterate(RecursiveIteratorIterator $iterator)

Iterate on next value

from  VisitorTrait
int|NdArray
axis(callable $func, int|float $number = null, bool $keepdims = false)

Execute axis operations and return an aggregate

from  VisitorTrait
mixed
__call(string $name, array|null $arguments = null)

Call a np function

from  Decorator
NdArray
reciprocal()

Return the reciprocal of the argument, element-wise. {@link http://sciphp.org/ndarray.reciprocal}

from  Decorator
int|float|array
trace(int $k)

Sum along diagonals {@link http://sciphp.org/ndarray.trace}.

from  Decorator
NdArray
tril(int $k)

Lower triangle of an array {@link http://sciphp.org/ndarray.tril}

from  Decorator
NdArray
triu(int $k)

Upper triangle of an array {@link http://sciphp.org/ndarray.triu}

from  Decorator
NdArray
vander(int $num = null)

Generate a Vandermonde matrix. {@link http://sciphp.org/ndarray.vander}

from  Decorator
NdArray
signbit()

Returns element-wise true where signbit is set (less than zero). {@link http://sciphp.org/ndarray.signbit}

from  Decorator
NdArray
log(int|float $base = M_E)

Natural logarithm, element-wise. {@link http://sciphp.org/ndarray.log}

from  Decorator
NdArray
log10()

Base-10 logarithm, element-wise. {@link http://sciphp.org/ndarray.log10}

from  Decorator
NdArray
log2()

Base-2 logarithm, element-wise. {@link http://sciphp.org/ndarray.log2}

from  Decorator
NdArray
negative()

Numerical negative, element-wise. {@link http://sciphp.org/ndarray.negative}

from  Decorator
bool
is_square()

Is current matrix a square matrix. {@link http://sciphp.org/ndarray.is_square}

from  Decorator
NdArray
expm1()

Calculate exp(x) - 1 for all elements in the array. {@link http://sciphp.org/ndarray.expm1}

from  Decorator
NdArray
exp2()

Calculate 2**p for all p in the input array. {@link http://sciphp.org/ndarray.exp2}

from  Decorator
NdArray
power(float|int $exponent)

Matrix elements raised to powers. {@link http://sciphp.org/ndarray.power}

from  Decorator
NdArray
square()

The element-wise square of the input. {@link http://sciphp.org/ndarray.square}

from  Decorator
NdArray
sqrt()

The non-negative square-root of an array, element-wise. {@link http://sciphp.org/ndarray.sqrt}

from  Decorator
int|float|array
trapz()

Integrate along the given axis using the composite trapezoidal rule. {@link http://sciphp.org/ndarray.trapz}

from  Decorator
NdArray
sum(int|null $axis, bool $keepdims)

Sum all elements. {@link http://sciphp.org/ndarray.sum}

from  Decorator
NdArray
subtract(NdArray|array|float|int $input)

Subtract input from matrix. {@link http://sciphp.org/ndarray.subtract}

from  Decorator
NdArray
multiply(NdArray|array|float|int $input)

Multiply matrix by a given input, element-wise. {@link http://sciphp.org/ndarray.multiply}

from  Decorator
NdArray
copysign(NdArray|array|float|int $m)

Change the sign to that of given matrix, element-wise. {@link http://sciphp.org/ndarray.copysign}

from  Decorator
NdArray
cos()

Cosine element-wise. {@link http://sciphp.org/ndarray.cos}

from  Decorator
NdArray
sin()

Trigonometric sine, element-wise. {@link http://sciphp.org/ndarray.sin}

from  Decorator
NdArray
tan()

Compute tangent element-wise. {@link http://sciphp.org/ndarray.tan}

from  Decorator
NdArray
transform()

Transform a PHP array in a NdArray if needed

from  Decorator
__construct(array $data, string|null $identifier = null)

Constructor

string
__toString()

Pretty printer

Details

in ArithmeticTrait at line 29
final NdArray divide(NdArray|array|float|int $input)

Divide matrix by a given input, element-wise

Parameters

NdArray|array|float|int $input

Return Value

NdArray

in ArithmeticTrait at line 54
final NdArray dot(NdArray|array|float|int $input)

Dot matrix with an input

Parameters

NdArray|array|float|int $input

Return Value

NdArray

in ArithmeticTrait at line 77
final NdArray add(NdArray|array|float|int $input)

Add a matrix or a number

Parameters

NdArray|array|float|int $input

Return Value

NdArray

in AttributeTrait at line 25
final void __set(string $name, mixed $value)

Attribute setter

Parameters

string $name
mixed $value

Return Value

void

in AttributeTrait at line 44
final int|array|NdArray __get(string $name)

Generic getter

Parameters

string $name

Return Value

int|array|NdArray

Exceptions

InvalidAttributeException

in AttributeTrait at line 65
final protected int getSize()

Get the total number of elements of the array

Return Value

int

in ShapeTrait at line 86
final protected array getShape(int|float|array $data, array $shape)

Gets the dimensions of the array

Parameters

int|float|array $data Axis
array $shape

Return Value

array

in BasicTrait at line 21
final NdArray copy()

Create a copy

Return Value

NdArray

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

Get a view by index

Parameters

string|int $index

Return Value

mixed

in IndexTrait 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

in IndexTrait 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

in IndexTrait 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

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

Prepare filter values

Parameters

array $matches

Return Value

array

in IndexTrait 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

in IndexTrait at line 236
final bool offsetUnset(mixed $offset)

Remove a portion of the data array

Parameters

mixed $offset

Return Value

bool

in IndexTrait at line 246
final bool offsetExists(mixed $offset)

Check that an index is defined

Parameters

mixed $offset

Return Value

bool

in ShapeTrait at line 24
final NdArray ravel()

Flattens data array

Return Value

NdArray

in ShapeTrait at line 42
final NdArray resize()

Resize array

Return Value

NdArray

in ShapeTrait at line 65
final NdArray reshape()

Reshapes data

Return Value

NdArray

Exceptions

InvalidArgumentException if shape parameter has a different size

in VisitorTrait at line 20
final NdArray walk(callable $func)

Walk on first dimension

Parameters

callable $func

Return Value

NdArray

in VisitorTrait at line 30
final NdArray walk_recursive(callable $func)

Walk on last dimension

Parameters

callable $func

Return Value

NdArray

in VisitorTrait at line 42
final int|float iterate(RecursiveIteratorIterator $iterator)

Iterate on next value

Parameters

RecursiveIteratorIterator $iterator

Return Value

int|float

in VisitorTrait at line 74
final int|NdArray axis(callable $func, int|float $number = null, bool $keepdims = false)

Execute axis operations and return an aggregate

Parameters

callable $func
int|float $number
bool $keepdims

Return Value

int|NdArray

in Decorator at line 53
final mixed __call(string $name, array|null $arguments = null)

Call a np function

Parameters

string $name
array|null $arguments

Return Value

mixed

in Decorator at line 39
NdArray reciprocal()

Return the reciprocal of the argument, element-wise. {@link http://sciphp.org/ndarray.reciprocal}

Return Value

NdArray

in Decorator at line 39
int|float|array trace(int $k)

Sum along diagonals {@link http://sciphp.org/ndarray.trace}.

Parameters

int $k

Return Value

int|float|array

in Decorator at line 39
NdArray tril(int $k)

Lower triangle of an array {@link http://sciphp.org/ndarray.tril}

Parameters

int $k

Return Value

NdArray

in Decorator at line 39
NdArray triu(int $k)

Upper triangle of an array {@link http://sciphp.org/ndarray.triu}

Parameters

int $k

Return Value

NdArray

in Decorator at line 39
NdArray vander(int $num = null)

Generate a Vandermonde matrix. {@link http://sciphp.org/ndarray.vander}

Parameters

int $num

Return Value

NdArray

in Decorator at line 39
NdArray signbit()

Returns element-wise true where signbit is set (less than zero). {@link http://sciphp.org/ndarray.signbit}

Return Value

NdArray

in Decorator at line 39
NdArray log(int|float $base = M_E)

Natural logarithm, element-wise. {@link http://sciphp.org/ndarray.log}

Parameters

int|float $base

Return Value

NdArray

in Decorator at line 39
NdArray log10()

Base-10 logarithm, element-wise. {@link http://sciphp.org/ndarray.log10}

Return Value

NdArray

in Decorator at line 39
NdArray log2()

Base-2 logarithm, element-wise. {@link http://sciphp.org/ndarray.log2}

Return Value

NdArray

in Decorator at line 39
NdArray negative()

Numerical negative, element-wise. {@link http://sciphp.org/ndarray.negative}

Return Value

NdArray

in Decorator at line 39
bool is_square()

Is current matrix a square matrix. {@link http://sciphp.org/ndarray.is_square}

Return Value

bool

in Decorator at line 39
NdArray expm1()

Calculate exp(x) - 1 for all elements in the array. {@link http://sciphp.org/ndarray.expm1}

Return Value

NdArray

in Decorator at line 39
NdArray exp2()

Calculate 2**p for all p in the input array. {@link http://sciphp.org/ndarray.exp2}

Return Value

NdArray

in Decorator at line 39
NdArray power(float|int $exponent)

Matrix elements raised to powers. {@link http://sciphp.org/ndarray.power}

Parameters

float|int $exponent

Return Value

NdArray

in Decorator at line 39
NdArray square()

The element-wise square of the input. {@link http://sciphp.org/ndarray.square}

Return Value

NdArray

in Decorator at line 39
NdArray sqrt()

The non-negative square-root of an array, element-wise. {@link http://sciphp.org/ndarray.sqrt}

Return Value

NdArray

in Decorator at line 39
int|float|array trapz()

Integrate along the given axis using the composite trapezoidal rule. {@link http://sciphp.org/ndarray.trapz}

Return Value

int|float|array

in Decorator at line 39
NdArray sum(int|null $axis, bool $keepdims)

Sum all elements. {@link http://sciphp.org/ndarray.sum}

Parameters

int|null $axis
bool $keepdims

Return Value

NdArray

in Decorator at line 39
NdArray subtract(NdArray|array|float|int $input)

Subtract input from matrix. {@link http://sciphp.org/ndarray.subtract}

Parameters

NdArray|array|float|int $input

Return Value

NdArray

in Decorator at line 39
NdArray multiply(NdArray|array|float|int $input)

Multiply matrix by a given input, element-wise. {@link http://sciphp.org/ndarray.multiply}

Parameters

NdArray|array|float|int $input

Return Value

NdArray

in Decorator at line 39
NdArray copysign(NdArray|array|float|int $m)

Change the sign to that of given matrix, element-wise. {@link http://sciphp.org/ndarray.copysign}

Parameters

NdArray|array|float|int $m

Return Value

NdArray

in Decorator at line 39
NdArray cos()

Cosine element-wise. {@link http://sciphp.org/ndarray.cos}

Return Value

NdArray

in Decorator at line 39
NdArray sin()

Trigonometric sine, element-wise. {@link http://sciphp.org/ndarray.sin}

Return Value

NdArray

in Decorator at line 39
NdArray tan()

Compute tangent element-wise. {@link http://sciphp.org/ndarray.tan}

Return Value

NdArray

in Decorator at line 39
NdArray transform()

Transform a PHP array in a NdArray if needed

Return Value

NdArray

at line 29
__construct(array $data, string|null $identifier = null)

Constructor

Parameters

array $data
string|null $identifier A NdArray identifier

at line 37
string __toString()

Pretty printer

Return Value

string