Index | NumPhp API

A

ArithmeticTrait — Class in namespace SciPhp\NdArray: Arithmetic methods
ArithmeticTrait::add() — Method in class ArithmeticTrait: Add a matrix or a number
AttributeTrait — Class in namespace SciPhp\NdArray: Attribute methods for NdArray
VisitorTrait::axis() — Method in class VisitorTrait: Execute axis operations and return an aggregate
NumPhp::ar() — Method in class NumPhp: Construct a n-dimensional array
NumPhp::allNumeric() — Method in class NumPhp: Check that all values are numeric
ArithmeticTrait — Class in namespace SciPhp\NumPhp
ArithmeticTrait::add() — Method in class ArithmeticTrait: Add two array_like
RangeTrait::arange() — Method in class RangeTrait: Creates a NdArray with a range of values

B

BasicTrait — Class in namespace SciPhp\NdArray: Basics for NdArray
NumArrayTrait::broadcast_to() — Method in class NumArrayTrait: Broadcast an array to a new shape.

C

CholeskyTrait — Class in namespace SciPhp\LinAlg: Choleski decomposition
CholeskyTrait::cholesky() — Method in class CholeskyTrait: Decomposition of a Hermitian, positive-definite matrix into the product of a lower triangular matrix
BasicTrait::copy() — Method in class BasicTrait: Create a copy
Decorator::copysign() — Method in class Decorator: Change the sign to that of given matrix, element-wise. {@link http://sciphp.org/ndarray.copysign}
Decorator::cos() — Method in class Decorator: Cosine element-wise. {@link http://sciphp.org/ndarray.cos}
ArithmeticTrait::colDot() — Method in class ArithmeticTrait: Browse p cols and sum products
FloatTrait::copysign() — Method in class FloatTrait: Change the sign of m-element to that of n-element, element-wise.
TrigonometricTrait::cos() — Method in class TrigonometricTrait: Cosine element-wise.
NumArrayTrait::createArray() — Method in class NumArrayTrait: Construct a n-dim array with a default value

D

Decorator — Class in namespace SciPhp\LinAlg: Multiple inheritance for LinAlg
$ NdArray#data — Property in class NdArray: Access data as a PHP array.
ArithmeticTrait::divide() — Method in class ArithmeticTrait: Divide matrix by a given input, element-wise
ArithmeticTrait::dot() — Method in class ArithmeticTrait: Dot matrix with an input
$ AttributeTrait#data — Property in class AttributeTrait
Decorator — Class in namespace SciPhp\NdArray: Multiple inheritance for NdArray
ArithmeticTrait::divide() — Method in class ArithmeticTrait: Divide two arrays, element-wise
ArithmeticTrait::dot() — Method in class ArithmeticTrait: Dot product of two arrays
Decorator — Class in namespace SciPhp\NumPhp: Multiple inheritance for NumPhp
DiagonalTrait — Class in namespace SciPhp\NumPhp: Diagonal methods for NumPhp
DiagonalTrait::diag() — Method in class DiagonalTrait: Extract a diagonal or construct a diagonal array
DiagonalTrait::diagonal() — Method in class DiagonalTrait: Extract a diagonal
DiagonalTrait::diagflat() — Method in class DiagonalTrait: Create a two-dimensional array with the flattened input as a diagonal.
Decorator — Class in namespace SciPhp\Random: Multiple inheritance for Random

E

Decorator::expm1() — Method in class Decorator: Calculate exp(x) - 1 for all elements in the array. {@link http://sciphp.org/ndarray.expm1}
Decorator::exp2() — Method in class Decorator: Calculate 2**p for all p in the input array. {@link http://sciphp.org/ndarray.exp2}
DiagonalTrait::eye() — Method in class DiagonalTrait: Construct a diagonal array
ExponentTrait — Class in namespace SciPhp\NumPhp: Exponent methods
ExponentTrait::exp() — Method in class ExponentTrait: Calculate the exponential of all elements in the input array.
ExponentTrait::expm1() — Method in class ExponentTrait: Calculate exp(x) - 1 for all elements in the array.
ExponentTrait::exp2() — Method in class ExponentTrait: Calculate 2**p for all p in the input array.
ExtensionsTrait — Class in namespace SciPhp\NumPhp

F

Formatter — Class in namespace SciPhp\NdArray: NdArray formatter
IndexTrait::filterGet() — Method in class IndexTrait: Get values from an element or a range
IndexTrait::filterSet() — Method in class IndexTrait: Assign values to an element or a range
IndexTrait::filterRange() — Method in class IndexTrait: Get range definition
DiagonalTrait::fromDiagonal() — Method in class DiagonalTrait: Construct a diagonal array
FileTrait — Class in namespace SciPhp\NumPhp: File methods
FloatTrait — Class in namespace SciPhp\NumPhp: Floating point methods
NumArrayTrait::full() — Method in class NumArrayTrait: Creates a NdArray with a default value
NumArrayTrait::full_like() — Method in class NumArrayTrait: Construct a new array with the same shape and type as a given array, filled with a given value

G

AttributeTrait::getSize() — Method in class AttributeTrait: Get the total number of elements of the array
AttributeTrait::getShape() — Method in class AttributeTrait
ShapeTrait::getShape() — Method in class ShapeTrait: Gets the dimensions of the array

I

InvalidAttributeException — Class in namespace SciPhp\Exception
Decorator::is_square() — Method in class Decorator: Is current matrix a square matrix. {@link http://sciphp.org/ndarray.is_square}
IndexInterface — Class in namespace SciPhp\NdArray: Indexing constants
IndexTrait — Class in namespace SciPhp\NdArray: Indexing methods for NdArray
IndexTrait::indexFilter() — Method in class IndexTrait: Prepare filter values
VisitorTrait::iterate() — Method in class VisitorTrait: Iterate on next value
DiagonalTrait::identity() — Method in class DiagonalTrait: Construct an identity array
DiagonalTrait::itemFromDiagonal() — Method in class DiagonalTrait: Fill a line among diagonal, offset and indexes
MatrixTrait::is_square() — Method in class MatrixTrait: Is given matrix a square matrix ?
TriangleTrait::itemTriu() — Method in class TriangleTrait: Fill zeros from first item to a position
TriangleTrait::itemTril() — Method in class TriangleTrait: Fill zeros from a position to the end of the array
TriangleTrait::itemTri() — Method in class TriangleTrait: Return a closure that fill a line item with ones
VanderTrait::itemVander() — Method in class VanderTrait: Apply decreasing power on each row values

L

LinAlg — Class in namespace SciPhp: Linear algebra wrapper
Decorator::log() — Method in class Decorator: Natural logarithm, element-wise. {@link http://sciphp.org/ndarray.log}
Decorator::log10() — Method in class Decorator: Base-10 logarithm, element-wise. {@link http://sciphp.org/ndarray.log10}
Decorator::log2() — Method in class Decorator: Base-2 logarithm, element-wise. {@link http://sciphp.org/ndarray.log2}
ExtensionsTrait::linalg() — Method in class ExtensionsTrait: Loads Linear Algebra extension
FileTrait::loadtxt() — Method in class FileTrait: Load data from a text file.
LogarithmTrait — Class in namespace SciPhp\NumPhp
LogarithmTrait::log() — Method in class LogarithmTrait: Natural logarithm, element-wise.
LogarithmTrait::log10() — Method in class LogarithmTrait: Base 10 logarithm, element-wise.
LogarithmTrait::log2() — Method in class LogarithmTrait: Base 2 logarithm, element-wise.
RangeTrait::linspace() — Method in class RangeTrait
RangeTrait::logspace() — Method in class RangeTrait: Creates a NdArray with a range of values

M

Message — Class in namespace SciPhp\Exception
Decorator::multiply() — Method in class Decorator: Multiply matrix by a given input, element-wise. {@link http://sciphp.org/ndarray.multiply}
ArithmeticTrait::multiply() — Method in class ArithmeticTrait: Multiply two arrays, element-wise
MatrixTrait — Class in namespace SciPhp\NumPhp

N

NormsTrait — Class in namespace SciPhp\LinAlg: Norms methods
NormsTrait::norm() — Method in class NormsTrait: Matrix or vector norm.
NdArray — Class in namespace SciPhp: Base array
$ NdArray#ndim — Property in class NdArray: Number of dimensions of an array.
Decorator::negative() — Method in class Decorator: Numerical negative, element-wise. {@link http://sciphp.org/ndarray.negative}
NumPhp — Class in namespace SciPhp: Entry point for np calls.
MatrixTrait::negative() — Method in class MatrixTrait: Numerical negative, element-wise.
NumArrayTrait — Class in namespace SciPhp\NumPhp
NumArrayTrait::nulls() — Method in class NumArrayTrait: Creates a NdArray with null as default value 'empty' can not be used in PHP
NumArrayTrait::nulls_like() — Method in class NumArrayTrait: Construct a new array of nulls with the same shape and type as a given array.

O

IndexTrait::offsetGet() — Method in class IndexTrait: Get a view by index
IndexTrait::offsetSet() — Method in class IndexTrait: Set a view by index
IndexTrait::offsetUnset() — Method in class IndexTrait: Remove a portion of the data array
IndexTrait::offsetExists() — Method in class IndexTrait: Check that an index is defined
NumArrayTrait::ones() — Method in class NumArrayTrait: Creates a NdArray with one as default value
NumArrayTrait::ones_like() — Method in class NumArrayTrait: Construct a new array of ones with the same shape and type as a given array.
OperationTrait — Class in namespace SciPhp\NumPhp

P

Decorator::power() — Method in class Decorator: Matrix elements raised to powers. {@link http://sciphp.org/ndarray.power}
NumPhp::parseArgs() — Method in class NumPhp: Parse args as a tuple or an array
ExponentTrait::power() — Method in class ExponentTrait: Matrix elements raised to powers.

R

Decorator::reciprocal() — Method in class Decorator: Return the reciprocal of the argument, element-wise. {@link http://sciphp.org/ndarray.reciprocal}
ShapeTrait::ravel() — Method in class ShapeTrait: Flattens data array
ShapeTrait::resize() — Method in class ShapeTrait: Resize array
ShapeTrait::reshape() — Method in class ShapeTrait: Reshapes data
ArithmeticTrait::reciprocal() — Method in class ArithmeticTrait: Return the reciprocal of the argument, element-wise.
ArithmeticTrait::rowDot() — Method in class ArithmeticTrait: Browse p rows
ExtensionsTrait::random() — Method in class ExtensionsTrait: Loads Random generator extension
RangeTrait — Class in namespace SciPhp\NumPhp
Random — Class in namespace SciPhp: Random sampling entry point
RandomStateTrait — Class in namespace SciPhp\Random: Random generator methods.
RandomStateTrait::randn() — Method in class RandomStateTrait: Return a sample (or samples) from the “standard normal” distribution.
RandomStateTrait::rand() — Method in class RandomStateTrait: Random values in a given shape.
RandomStateTrait::randint() — Method in class RandomStateTrait: Return random integers from low (inclusive) to high (exclusive).

S

$ NdArray#size — Property in class NdArray: Number of elements of an array.
$ NdArray#shape — Property in class NdArray: Tuple of array dimensions.
Decorator::signbit() — Method in class Decorator: Returns element-wise true where signbit is set (less than zero). {@link http://sciphp.org/ndarray.signbit}
Decorator::square() — Method in class Decorator: The element-wise square of the input. {@link http://sciphp.org/ndarray.square}
Decorator::sqrt() — Method in class Decorator: The non-negative square-root of an array, element-wise. {@link http://sciphp.org/ndarray.sqrt}
Decorator::sum() — Method in class Decorator: Sum all elements. {@link http://sciphp.org/ndarray.sum}
Decorator::subtract() — Method in class Decorator: Subtract input from matrix. {@link http://sciphp.org/ndarray.subtract}
Decorator::sin() — Method in class Decorator: Trigonometric sine, element-wise. {@link http://sciphp.org/ndarray.sin}
ShapeTrait — Class in namespace SciPhp\NdArray: Shape methods for NdArray
ArithmeticTrait::subtract() — Method in class ArithmeticTrait: Subtract a matrix from matrix
ExponentTrait::square() — Method in class ExponentTrait: The element-wise square of the input.
ExponentTrait::sqrt() — Method in class ExponentTrait: The non-negative square-root of an array, element-wise.
FloatTrait::signbit() — Method in class FloatTrait: Returns element-wise true where signbit is set (less than zero).
TrigonometricTrait::sin() — Method in class TrigonometricTrait: Trigonometric sine, element-wise.
OperationTrait::sum() — Method in class OperationTrait: Sum all elements.

T

$ NdArray#T — Property in class NdArray: Permute the dimensions of an array.
Decorator::trace() — Method in class Decorator: Sum along diagonals {@link http://sciphp.org/ndarray.trace}.
Decorator::tril() — Method in class Decorator: Lower triangle of an array {@link http://sciphp.org/ndarray.tril}
Decorator::triu() — Method in class Decorator: Upper triangle of an array {@link http://sciphp.org/ndarray.triu}
Decorator::trapz() — Method in class Decorator: Integrate along the given axis using the composite trapezoidal rule. {@link http://sciphp.org/ndarray.trapz}
Decorator::tan() — Method in class Decorator: Compute tangent element-wise. {@link http://sciphp.org/ndarray.tan}
Decorator::transform() — Method in class Decorator: Transform a PHP array in a NdArray if needed
Formatter::toString() — Method in class Formatter: Stringify an array
NumPhp::transform() — Method in class NumPhp: Transform a PHP array in a NdArray
DiagonalTrait::trace() — Method in class DiagonalTrait: Sum along diagonals
TrigonometricTrait — Class in namespace SciPhp\NumPhp\Mathematical: Trigonometric methods
TrigonometricTrait::tan() — Method in class TrigonometricTrait: Compute tangent element-wise.
MatrixTrait::transpose() — Method in class MatrixTrait: Permute the dimensions of an array.
OperationTrait::trapz() — Method in class OperationTrait: Integrate along the given axis using the composite trapezoidal rule.
TriangleTrait — Class in namespace SciPhp\NumPhp
TriangleTrait::triu() — Method in class TriangleTrait: Upper triangle of an array
TriangleTrait::tril() — Method in class TriangleTrait: Lower triangle of an array
TriangleTrait::tri() — Method in class TriangleTrait: Construct an array with ones at and below the given diagonal and zeros elsewhere

V

Decorator::vander() — Method in class Decorator: Generate a Vandermonde matrix. {@link http://sciphp.org/ndarray.vander}
VisitorTrait — Class in namespace SciPhp\NdArray: Visitor methods
VanderTrait — Class in namespace SciPhp\NumPhp
VanderTrait::vander() — Method in class VanderTrait: Generate a Vandermonde matrix.

W

VisitorTrait::walk() — Method in class VisitorTrait: Walk on first dimension
VisitorTrait::walk_recursive() — Method in class VisitorTrait: Walk on last dimension

Z

NumArrayTrait::zeros() — Method in class NumArrayTrait: Creates a NdArray with zero as default value
NumArrayTrait::zeros_like() — Method in class NumArrayTrait: Construct a new array of zeros with the same shape and type as a given array.

_

InvalidAttributeException::__construct() — Method in class InvalidAttributeException
NdArray::__construct() — Method in class NdArray: Constructor
NdArray::__toString() — Method in class NdArray: Pretty printer
AttributeTrait::__set() — Method in class AttributeTrait: Attribute setter
AttributeTrait::__get() — Method in class AttributeTrait: Generic getter
Decorator::__call() — Method in class Decorator: Call a np function
Formatter::__construct() — Method in class Formatter: Set array data and options