KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

Matrix

★ 38 Open GitHub ↗

Easy-to-use Scientific Computing library in/for C++ available for Linux and Windows.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Matrix

[![Join the chat at https://gitter.im/mlcpp/Matrix](https://badges.gitter.im/mlcpp/Matrix.svg)](https://gitter.im/mlcpp/Matrix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

![](https://socialify.git.ci/mlcpp/Matrix/image?description=1&font=Source%20Code%20Pro&forks=1&language=1&owner=1&pattern=Signal&stargazers=1&theme=Dark)

## Table of Contents

1. [Installation](#installation)

2. [Development](#development)

2.1. [Linux](#linux)

2.2. [Windows](#windows)

3. [Benchmarking](#benchmarking)

4. [Testing](#testing)

5. [Quick Start Guide](#quick-start-guide)

5.1. [Initializers](#initializers)

5.2. [Slicing](#slicing)

5.3. [Printing/Viewing](#printingviewing)

5.4. [Indexing](#indexing)

5.5. [Operators](#operators)

5.6. [Broadcasting](#broadcasting)

5.7. [Minimum, Maximum](#minimum-maximum)

5.8. [Mathematical Operations](#mathematical-operations)

5.9. [Statistical Operations](#statistical-operations)

5.10. [Matrix Algebra](#matrix-algebra)

5.11. [Miscellaneous](#miscellaneous)

## Installation

This describes the installation process using cmake. As pre-requisites, you'll
need git and cmake installed.

```bash
# Check out the library.
$ git clone https://github.com/mlcpp/Matrix.git && cd Matrix

# Make a build directory to place the build output.
$ cmake -E make_directory "build"

# Generate build system files with cmake.
$ cmake -E chdir "build" cmake -DCMAKE_BUILD_TYPE=Release ../

# Build the library.
$ cmake -DCMAKE_BUILD_TYPE=Release -S . -B "build"

```

On a unix system, the build directory should now look something like this:

```
/Matrix
  /build
    /examples
      /abs
      /addition
      ...
```

## Development

### Linux

#### Prerequisites

1. C++ compiler (gcc or clang)
2. git
3. clang-format
4. make (for Makefiles)
5. cmake (version 3.13 or higher)

```bash
# Check out the library.
$ git clone https://github.com/mlcpp/Matrix.git && cd Matrix

# Create build directory.
$ mkdir build

# Enter into build directory.
$ cd build

# Run CMake. This step will generate a Makefile in the build/ folder.
$ cmake ../

# Compile all files and place the binaries inside build/examples/ folder.
$ make

# Compile single file and place the binary inside build/examples/ folder.
$ make <file_name_without_extension>
```

### Windows

#### Prerequisites

1. C++ compiler (mingw-gcc)
2. git (msysgit)
3. clang-format
4. mingw-make or mingw32-make (for Makefiles)
5. cmake (version 3.13 or higher)

Add these tools to PATH.

**Note**: Run the following commands in msysgit terminal.

```bash
# Check out the library.
$ git clone https://github.com/mlcpp/Matrix.git && cd Matrix

# Create build directory.
$ mkdir build

# Enter into build directory.
$ cd build

# Run CMake. This step will generate a Makefile in the build/ folder.
$ cmake ../

# Compile all files and place the binaries inside build/examples/ folder.
$ mingw-make                                          # use mingw32-make if using 32-bit Windows

# Compile single file and place the binary inside build/examples/ folder.
$ mingw-make <file_name_without_extension> # use mingw32-make if using 32-bit Windows
```

## Benchmarking

To compile g_benchmark binaries:

Linux: `make benchmarks`

Windows: `mingw32-make benchmarks`

## Testing

To compile g_test binaries:

Linux: `make tests`

Windows: `mingw32-make tests`

## Quick Start Guide

This guide contains detailed explanation of all the methods and functions available and how to use them.

More detailed information about how to use these methods and functions is available in `/examples`.

**Note:** Here `d-type` means any C++ data type.

### Initializers

Many initializer functions are provided that return `Matrix` object.

| **Function** | **Parameters** | **Return value** | **Description** |
| :-------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------: | :-----------------------------------------------------------------------------------: |
| `matrix.init()` | _1 Parameter:_ Type: `d-type`/`std::vector<d-type>`/`std::vector<std::vector<d-type>>`/`std::vector<std::vector<std::string>>` Job: value(s) of elements in the `Matrix` object | `Matrix` object | Creates a `Matrix` object of same dimensions and values as provided in the parameter. |
| `matrix.eye()` | _1 Parameter:_ Type: `int` Job: Size of the identity matrix | `Matrix` object | Creates an identity `Matrix` object of the size given as parameters. |
| `matrix.zeros()` | _2 Parameters:_ Type: `int`; `int` Job: Number of rows; Number of columns | `Matrix` object | Creates a `Matrix` object of all elements `0` of the size given as parameters. |
| `matrix.ones()` | _2 Parameters:_ Type: `int`; `int` Job: Number of rows; Number of columns | `Matrix` object | Creates a `Matrix` object of all elements `1` of the size given as parameters. |
| `matrix.genfromtxt()` | _2 Parameters:_ Type: `std::string`;`char` Job: Path of the `.csv` file | `Matrix` object | Creates a `Matrix` object with data elements as in the given file. |

### Slicing

`Matrix` objects can be sliced like `NumPy` arrays.

| **Function** | **Parameters** | **Return value** | **Description** |
| :---------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------: | :--------------------------------------------------------------------------------------------------------------------------------: |
| `Matrix.slice()` | _4 Parameter:_ Type: `int`; `int`; `int`; `int` Job: Starting row index; Ending row index; Starting column index; Ending column index | `Matrix` object | Slices the `Matrix` object according to the indices provided. |
| `Matrix.slice_select()` | _4 Parameter:_ Type: `Matrix<d-type1>`; `Matrix<d-type2>`; `d-type2`; `int` Job: `Matrix` to select values on; `Matrix` to select values from; value to select; column index on which to select | `Matrix` object | Slices the `Matrix` object to get all rows which have value(3rd parameter) in second `Matrix` object and one column(4th parameter) |

### Printing/Viewing

A number of methods are provided to print/view a `Matrix` object in different ways.

### Indexing

Indexing can be used to get or assign value to a particular element.

For example, let there is a `Matrix` object named mat. If we want to get the value at index (5,3) we can do this as follows:

double val = mat(5,3);

Similarly, if we want to assign the value to index (5,3) we can do this by:

mat(5,3) = 10.54;

### Operators

Support for almost all standard C++ operators is provided. This includes:

<ul>
<li>Arithmetic operators (+, -, \*, /)
<li>Compound assignment operatos (+=, -=, \*=, /=)
<li>Increment and decrement operators (++, --)
<li>Relational and Comparison operators (==, !=, <, >, <=, >=)
<li>Unary Minus (-)
</ul>

### Broadcasting

Broadcasting is in-built in the Basic Mathematical operations i.e., addition, subtraction, multiplication and division.

Following binary operations are possible:

<ul>
<li>Matrix = Matrix @ Matrix
<li>Matrix = Matrix @ Vector
<li>Matrix = Matrix @ Scalar
</ul>

where, @ is any operator from (+, -, \*, /)

**Note:** Vector is a `Matrix` object where row length **or** column length is equal to 1.

Following unary operations are possible:

<ul>
<li>Matrix = @Matrix
</ul>

where, @ is any operator from (-)

### Minimum, Maximum

| **Function** | **Parameters** | **Return value** | **Description** |
| :---------------: | :------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------: | :----------------------------------------------------: |
| `matrix.min()` | _2 Parameters:_ Type: `Matrix`; `std::string` Job: `Matrix` to find minimum; dimension across which to find minimum | `Matrix` object | Method to get the minimum value along an axis |
| `matrix.max()` | _2 Parameters:_ Type: `Matrix`; `std::string` Job: `Matrix` to find maximum; dimension across which to find maximum | `Matrix` object | Method to get the maximum value along an axis |
| `matrix.argmin()` | _2 Parameters:_ Type: `Matrix`; `std::string` Job: `Matrix` to find index of minimum; dimension across which to find index of minimum | `Matrix` object | Method to get the index of minimum value along an axis |
| `matrix.argmax()` | _2 Parameters:_ Type: `Matrix`; `std::string` Job: `Matrix` to find index of maximum; dimension across which to find index of maximum | `Matrix` object | Method to get the index of maximum value along an axis |

### Mathematical Operations

| **Function** | **Parameters** | **Return value** | **Description** |
| :--------------: | :-----------------------------------------------------------------------------------------------------------------------: | :--------------: | :---------------------------------------------------------------------------------: |
| `matrix.sqrt()` | _1 Parameter:_ Type: `Matrix` Job: `Matrix` object to apply method on | `Matrix` object | Method to get the sqrt of each element of a`Matrix` object |
| `matrix.power()` | _2 Parameters:_ Type: `Matrix`; `double` Job: `Matrix` object to apply method on; power of `Matrix` elements | `Matrix` object | Method to calculate power of each element of a `Matrix` object |
| `matrix.power()` | _2 Parameters:_ Type: `Matrix`; `Matrix` Job: `Matrix` object to apply method on; power of `Matrix` elements | `Matrix` object | Method to calculate power of each element of a `Matrix` object |
| `matrix.exp()` | _1 Parameter:_ Type: `Matrix` Job: `Matrix` object to apply method on | `Matrix` object | Method to calculate exponential of all elements in the `Matrix` object |
| `matrix.log()` | _1 Parameter:_ Type: `Matrix` Job: `Matrix` object to apply method on | `Matrix` object | Method to calculate natural logarithm of all elements in the in the `Matrix` object |
| `matrix.abs()` | _1 Parameter:_ Type: `Matrix` Job: `Matrix` object to apply method on | `Matrix` object | Method to get absolute value of all elements in the in the `Matrix` object |

**Note:** Broadcasting in power() methods works in the same way as in Basic Mathematical operations.

### Statistical Operations

| **Function** | **Parameters** | **Return value** | **Description** |
| :-------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------: | :--------------------------------------------------------------------------: |
| `matrix.sum()` | _2 Parameters:_ Type: `Matrix`; `std::string` Job: `Matrix` object to apply method on; Dimension on which to calculate sum | `Matrix` object | Method to calculate the sum over an axis of a`Matrix` object |
| `matrix.mean()` | _2 Parameters:_ Type: `Matrix`; `std::string` Job: `Matrix` object to apply method on; Dimension on which to calculate mean | `Matrix` object | Method to calculate the mean over an axis of a `Matrix` object |
| `matrix.std()` | _2 Parameters:_ Type: `Matrix`; `std::string` Job: `Matrix` object to apply method on; Dimension on which to calculate standard deviation | `Matrix` object | Method to calculate the standard deviation over an axis of a `Matrix` object |

### Matrix Algebra

### Miscellaneous

Matrix

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README