Skip to content

Latest commit

 

History

History
100 lines (77 loc) · 2.82 KB

README.md

File metadata and controls

100 lines (77 loc) · 2.82 KB
Raw

Vector3 – SIMD 3D-vector C++ implementation

This is a simple C++ library implementing a mathematical 3D-vector class using SIMD instructions. It based on this version.

Example

test.cpp

#include <iostream>
#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

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.

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.