API Reference

Complete reference for all NDArray classes and methods.

Core

• NDArray Class - Main array class with properties
• Array Creation - Array creation methods

Array Manipulation

• Array Manipulation - Reshape, transpose, stacking, splitting
• Indexing Routines - Access and modify elements
• Array Import and Export - Converting to/from other formats

Mathematical Operations

• Mathematical Functions - Arithmetic, trigonometry, exponentials, rounding
• Logic Functions - Comparison operations (eq, gt, lt, etc.)
• Bitwise Operations - Bitwise AND, OR, XOR, shifts
• Statistics - Sum, mean, variance, min, max
• Sorting, Searching, and Counting - Sort, argsort, argmin, argmax
• Linear Algebra - Matrix operations
• Signal Processing - FFT, real FFT, and DCT
• Window Functions - Hann, Hamming, Blackman, Kaiser, and more

Global functions

• Global functions — Full list, import examples, and links back to each topic page.

Other

• Exceptions - Error handling

Quick Reference

Most Common Methods

Creation:

• NDArray::array() - From PHP array
• NDArray::zeros() - Array of zeros
• NDArray::ones() - Array of ones
• NDArray::random() - Random values

Properties:

• shape(), shape(?int $axis) - Full shape list, or length of one axis (-1 = last)
• dtype() - Get data type
• size() - Total elements

Math:

• add(), subtract(), multiply(), divide()
• sum(), mean(), std(), min(), max()

Shape:

• reshape(), transpose(), flatten()
• slice() - Extract subarrays

Global functions

Most operations from the method reference are also available as functions under PhpMlKit\NDArray (and in the Linalg, Fft, and Windows sub-namespaces). See the exhaustive global functions page.

Next Steps

• Getting Started
• Quick Start