README

NumPhp is a port of the famous NumPy (Python) package in PHP language.

• Documentation
• Code coverage
• API

Table of contents

• Requirements
• Installation
• Basic Usage
• Documentation
  • NdArray attributes
  • NdArray methods
  • NumPhp methods
• Contributing

Requirements

NumPhp supports PHP 7.2, 7.3 7.4 and 8.0.

Install

composer require sciphp/numphp

Basic usage

use SciPhp\NumPhp as np;

$m = np::ar(
  [[ 1, 0, 0],
   [ 0, 1, 0],
   [ 0, 0, 1]]
)->dot(42);

echo "m.42 =\n$m";

will output:

m.42 =
[[ 42,  0,  0 ],
 [  0, 42,  0 ],
 [  0,  0, 42 ]]

Documentation

NdArray attributes

• NdArray::data
• NdArray::ndim
• NdArray::shape
• NdArray::size
• NdArray::T

NdArray methods

• NdArray::copy
• NdArray::negative
• NdArray::ravel
• NdArray::reshape
• NdArray::resize
• NdArray::add
• NdArray::divide
• NdArray::dot
• NdArray::multiply
• NdArray::reciprocal
• NdArray::subtract
• NdArray::sum
• NdArray::trace
• NdArray::trapz
• NdArray::log
• NdArray::log10
• NdArray::log2
• NdArray::exp
• NdArray::expm1
• NdArray::exp2
• NdArray::power
• NdArray::sqrt
• NdArray::square
• NdArray::tril
• NdArray::triu
• NdArray::copysign
• NdArray::signbit
• NdArray::vander
• NdArray::is_square

NumPhp methods

• NumPhp::ar
• NumPhp::full
• NumPhp::nulls
• NumPhp::ones
• NumPhp::zeros
• NumPhp::full_like
• NumPhp::nulls_like
• NumPhp::zeros_like
• NumPhp::arange
• NumPhp::linspace
• NumPhp::logspace
• NumPhp::loadtxt
• NumPhp::diag
• NumPhp::diagflat
• NumPhp::diagonal
• NumPhp::eye
• NumPhp::negative
• NumPhp::identity
• NumPhp::trace
• NumPhp::tri
• NumPhp::tril
• NumPhp::triu
• NumPhp::vander
• NumPhp::add
• NumPhp::divide
• NumPhp::dot
• NumPhp::multiply
• NumPhp::power
• NumPhp::sqrt
• NumPhp::square
• NumPhp::reciprocal
• NumPhp::subtract
• NumPhp::transpose
• NumPhp::sum
• NumPhp::trapz
• NumPhp::log
• NumPhp::log10
• NumPhp::log2
• NumPhp::exp
• NumPhp::expm1
• NumPhp::exp2
• NumPhp::signbit
• NumPhp::copysign
• NumPhp::broadcast_to
• NumPhp::is_square

In the complete documentation, you will find all implemented stuff including some Linear Algebra methods like matrix norms and Cholesky transformation.

Contributing

Feel free to open issues and make PR. Contributions are welcome.

If you find a mistake or think an example is missing in the documentation, it's hosted on numphp-doc repository.