1. trait
  2. SciPhp
  3. \
  4. NumPhp
  5. \
  6. DiagonalTrait

DiagonalTrait

trait DiagonalTrait (View source)

Diagonal methods for NumPhp

Methods

static int|float|array
trace(NdArray|array $m, int $k = 0)

Sum along diagonals

static NdArray
identity(int $n)

Construct an identity array

static NdArray
eye(int $rows, int $cols = 0, int $k = 0)

Construct a diagonal array

static NdArray
diag(array|NdArray $m, int $k = 0)

Extract a diagonal or construct a diagonal array

static NdArray
diagonal(NdArray|array $m, int $k = 0)

Extract a diagonal

static NdArray
diagflat(mixed $m, int $k = 0)

Create a two-dimensional array with the flattened input as a diagonal.

static NdArray
fromDiagonal(array $diagonal, int $k)

Construct a diagonal array

static callable
itemFromDiagonal(int $col, array $diagonal, int $k, int $line = 1)

Fill a line among diagonal, offset and indexes

Details

at line 27
final static int|float|array trace(NdArray|array $m, int $k = 0)

Sum along diagonals

Parameters

NdArray|array $m
int $k offset

Return Value

int|float|array

Exceptions

InvalidArgumentException

at line 44
final static NdArray identity(int $n)

Construct an identity array

Parameters

int $n

Return Value

NdArray

Exceptions

InvalidArgumentException

at line 61
final static NdArray eye(int $rows, int $cols = 0, int $k = 0)

Construct a diagonal array

Parameters

int $rows Number of rows
int $cols Number of columns
int $k Offset

Return Value

NdArray

at line 96
final static NdArray diag(array|NdArray $m, int $k = 0)

Extract a diagonal or construct a diagonal array

Parameters

array|NdArray $m
int $k Diagonal

Return Value

NdArray

Exceptions

InvalidArgumentException

at line 117
final static NdArray diagonal(NdArray|array $m, int $k = 0)

Extract a diagonal

Parameters

NdArray|array $m
int $k Offset

Return Value

NdArray

at line 150
final static NdArray diagflat(mixed $m, int $k = 0)

Create a two-dimensional array with the flattened input as a diagonal.

Parameters

mixed $m An array to flatten
int $k

Return Value

NdArray

at line 164
final static protected NdArray fromDiagonal(array $diagonal, int $k)

Construct a diagonal array

Parameters

array $diagonal
int $k

Return Value

NdArray

at line 187
final static protected callable itemFromDiagonal(int $col, array $diagonal, int $k, int $line = 1)

Fill a line among diagonal, offset and indexes

Parameters

int $col Diagonal column index
array $diagonal
int $k Offset
int $line

Return Value

callable