Git Product home page Git Product logo

math's Introduction

Stand With Ukraine

mal-math

mal-math is a comprehensive C++20 mathematics library, providing a suite of utilities and structures to handle various mathematical constructs in an efficient and user-friendly manner.

Table of Contents

Features

  • Matrices, vectors and quaternions: Generic mathematicals structures, supporting different dimensions and primitive types.
  • Efficiency: Highly optimized functions using modern C++ features.
  • Extensibility: Built with modularity in mind, making it easier to extend or adapt to specific needs.
  • Doxygen Comments: Comprehensive Doxygen documentation for all classes, functions, and members, enabling automatic generation of detailed documentation.
  • Downsides: Doesn't have SIMD(Uyet).

Installation

  1. Clone the repository:
    git clone https://github.com/malatindez/math
    

Usage

Here's a basic example on how to use the vec structure:

#include "mal-math/vec.hpp"

int main() {
    mal_math::vec3 v1(1.0f, 2.0f, 3.0f);
    mal_math::vec3 v2(2.0f, 3.0f, 4.0f);
    mal_math::mat3 m1(v1, v2, 3,4,5);
    mal_math::mat3 m2(v1, v1, v1);
    auto result_v = v1 + v2;
    auto result_m = m1 + m2;
    std::cout << result_v; // 
    std::cout << result_m; // operator<< is overloaded as well
    // Do more stuff...
    return 0;
}

Documentation

The documentation is available @ malatindez.github.io/math

Contribute

  1. Fork the repository.
  2. Create your feature branch: git checkout -b feature/my-new-feature
  3. Commit your changes: git commit -m "Add my new feature"
  4. Push to the branch: git push origin feature/my-new-feature
  5. Submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

math's People

Contributors

malatindez avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.