https://github.com/pjessesco/peanut

🥜 Simple header-only C++20 matrix library using expression templates
https://github.com/pjessesco/peanut

cpp20 expression-template header-only matrix matrix-library modern-cpp template-metaprogramming

Last synced: about 2 months ago
JSON representation

🥜 Simple header-only C++20 matrix library using expression templates

• Host: GitHub
• URL: https://github.com/pjessesco/peanut
• Owner: pjessesco
• License: mit
• Created: 2022-05-24T12:16:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-28T12:37:53.000Z (10 months ago)
• Last Synced: 2024-02-28T14:29:29.249Z (10 months ago)
• Topics: cpp20, expression-template, header-only, matrix, matrix-library, modern-cpp, template-metaprogramming
• Language: C++
• Homepage: https://pjessesco.github.io/peanut/
• Size: 4.81 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Peanut

[![Unit Test (macOS, AppleClang)](https://github.com/pjessesco/peanut/actions/workflows/unittest_macos_appleclang.yml/badge.svg?branch=main)](https://github.com/pjessesco/peanut/actions/workflows/unittest_macos_appleclang.yml) 

[![Unit Test (macOS, Clang)](https://github.com/pjessesco/peanut/actions/workflows/unittest_macos_clang.yml/badge.svg?branch=main)](https://github.com/pjessesco/peanut/actions/workflows/unittest_macos_clang.yml) 

[![Unit Test (Ubuntu)](https://github.com/pjessesco/peanut/actions/workflows/unittest_ubuntu.yml/badge.svg?branch=main)](https://github.com/pjessesco/peanut/actions/workflows/unittest_ubuntu.yml) 

[![Unit Test (Windows MSVC)](https://github.com/pjessesco/peanut/actions/workflows/unittest_windows_msvc.yml/badge.svg?branch=main)](https://github.com/pjessesco/peanut/actions/workflows/unittest_windows_msvc.yml)

[![Unit Test (Windows Clang)](https://github.com/pjessesco/peanut/actions/workflows/unittest_windows_clang.yml/badge.svg?branch=main)](https://github.com/pjessesco/peanut/actions/workflows/unittest_windows_clang.yml) 

[![Deploy doxygen documents](https://github.com/pjessesco/peanut/actions/workflows/docs.yml/badge.svg?branch=main)](https://github.com/pjessesco/peanut/actions/workflows/docs.yml)

**Peanut** is a header-only matrix library using C++20 without any external dependencies, (except unit test), following a `expression templates` concept. It first constructs matrix expression as a user provides, and evaluates it using an automatically generated code in a compile-time.

```

Matrix mat1{1,2,3,4,

                       1,2,3,4,

                       1,2,3,4,

                       1,2,3,4};

Matrix mat2{1,2,3,4,5,

                       1,2,3,4,5,

                       1,2,3,4,5};

// Peanut first build expression tree,

// `result` type is `MatrixMult, MatrixInverse>>, MatrixMinor>>, MatrixSub<2, 1, MatrixMult>, Matrix>>>`.

auto result = (mat1 + Inverse(mat1) - Minor(mat1)) * SubMat<2, 1>(T(mat2) * mat2);

// then evaluate it when `eval()` is called or assigned to `Matrix` type variable.

/* Matrix */ auto e1 = result.eval();

Matrix e2 = result;

```

### Features

- Arbitrary size matrix expression

- Lazy evaluation

- Unit test

### Usage

Copy `Peanut` directory to your project, and add and its path to the include path. If you're using CMake, add :

    add_subdirectory(ext/peanut)

    include_directories(ext/peanut/include)

Then include as below :

    #include 

Refer [documentation](https://pjessesco.github.io/peanut/) for more information.