https://github.com/pelletier/vector3

SIMD 3D-vector C++ implementation
https://github.com/pelletier/vector3

Last synced: 2 months ago
JSON representation

SIMD 3D-vector C++ implementation

• Host: GitHub
• URL: https://github.com/pelletier/vector3
• Owner: pelletier
• Created: 2015-02-07T13:06:10.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-07T13:14:45.000Z (almost 10 years ago)
• Last Synced: 2024-05-08T17:38:42.782Z (8 months ago)
• Language: C++
• Size: 121 KB
• Stars: 29
• Watchers: 6
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vector3 – SIMD 3D-vector C++ implementation

This is a simple C++ library implementing a mathematical 3D-vector class using

[SIMD](http://www.wikiwand.com/en/SIMD) instructions. It based on [this

version](http://fastcpp.blogspot.fr/2011/12/simple-vector3-class-with-sse-support.html).

## Example

**test.cpp**

```c++

#include 

#include "vector3.h"

int main() {

    Vector3 a(1, 1, 1);

    Vector3 b(2, 0, -1);

    std::cout << "a:\t" << a << std::endl

              << "b:\t" << b << std::endl

              << "a.x:\t" << a.x << std::endl

              << "add:\t" << a + b << std::endl

              << "sub:\t" << a - b << std::endl

              << "dot:\t" << a.dot(b) << std::endl

              << "smult:\t" << 2 * b << std::endl;

    return 0;

}

```

**compile**

```bash

c++ -o test test.cpp vector3.cpp -msse4

```

**outuput**

```

a:	Vector3(1, 1, 1)

b:	Vector3(2, 0, -1)

a.x:	1

add:	Vector3(3, 1, 0)

sub:	Vector3(-1, 1, 2)

dot:	1

smult:	Vector3(4, 0, -2)

```

## Supported operations

The provided class name is Vector3. All values are in floating-point precision.

* Element-wise addition

* Element-wise subtraction

* Element-wise multiplication

* Element-wise division

* Scalar addition

* Scalar subtraction

* Scalar multiplication

* Scalar division

* Dot product

* Normalization

* Norm computing

* Equality testing

The exhaustive list is available [vector3.h](vector3.h).

## Compiler flags

You need to enable SSE2, SEE3 and SSE4 instructions on your compiler. GCC

/ Clang use `-msse4` to enable the needed instruction sets.

## Compatibility notes

* This version uses SSE4 instructions and is not meant to be backward

  compatible.

* It is supposed to work on Linux, OS X and Windows, although it has not been

  extensively tested on every operating system.

## License

The MIT License (MIT)

Copyright (c) 2015 Thomas Pelletier

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the "Software"), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies

of the Software, and to permit persons to whom the Software is furnished to do

so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.