Hermes
Classes | Typedefs | Functions
quaternion.h File Reference
Geometry

Geometric quaternion class. More...

Go to the source code of this file.

Classes

class  hermes::Quaternion< T >
 Quaternion representation v.x i + v.y j + v.z k + r. More...
 

Typedefs

using hermes::quat = Quaternion< real_t >
 
using hermes::quatf = Quaternion< f32 >
 
using hermes::quatd = Quaternion< f64 >
 

Functions

template<typename T >
HERMES_DEVICE_CALLABLE Quaternion< T > hermes::operator/ (const Quaternion< T > &q, T s)
 Scalar division. More...
 
template<typename T >
HERMES_DEVICE_CALLABLE Quaternion< T > hermes::operator* (const Quaternion< T > &q, T s)
 Scalar multiplication. More...
 
template<typename T >
HERMES_DEVICE_CALLABLE Quaternion< T > hermes::operator* (T s, const Quaternion< T > &q)
 Scalar multiplication. More...
 
template<typename T >
HERMES_DEVICE_CALLABLE Quaternion< T > hermes::operator+ (const Quaternion< T > &q, const Quaternion< T > &p)
 Adds two quaternions. More...
 
template<typename T >
HERMES_DEVICE_CALLABLE Quaternion< T > hermes::operator- (const Quaternion< T > &q, const Quaternion< T > &p)
 Subtracts p from q. More...
 
template<typename T >
HERMES_DEVICE_CALLABLE Quaternion< T > hermes::operator* (const Quaternion< T > &q, const Quaternion< T > &p)
 Multiplies quaternions. More...
 
template<typename T >
std::ostream & hermes::operator<< (std::ostream &os, const Quaternion< T > &v)
 Quaternion support for std::ostream::<< operator. More...
 

Detailed Description

Geometric quaternion class.

Copyright (c) 2022, FilipeCN.

The MIT License (MIT)

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.

Author
FilipeCN (filip.nosp@m.edec.nosp@m.n@gma.nosp@m.il.c.nosp@m.om)
Date
2022-02-09

Function Documentation

◆ operator*() [1/3]

template<typename T >
HERMES_DEVICE_CALLABLE Quaternion<T> hermes::operator* ( const Quaternion< T > &  q,
const Quaternion< T > &  p 
)
inline

Multiplies quaternions.

Template Parameters
T
Parameters
q
p
Returns

◆ operator*() [2/3]

template<typename T >
HERMES_DEVICE_CALLABLE Quaternion<T> hermes::operator* ( const Quaternion< T > &  q,
T  s 
)
inline

Scalar multiplication.

Template Parameters
T
Parameters
q
s
Returns

◆ operator*() [3/3]

template<typename T >
HERMES_DEVICE_CALLABLE Quaternion<T> hermes::operator* ( T  s,
const Quaternion< T > &  q 
)
inline

Scalar multiplication.

Template Parameters
T
Parameters
s
q
Returns

◆ operator+()

template<typename T >
HERMES_DEVICE_CALLABLE Quaternion<T> hermes::operator+ ( const Quaternion< T > &  q,
const Quaternion< T > &  p 
)
inline

Adds two quaternions.

Note
q.v + p.v, q.r + p.r
Template Parameters
T
Parameters
q
p
Returns

◆ operator-()

template<typename T >
HERMES_DEVICE_CALLABLE Quaternion<T> hermes::operator- ( const Quaternion< T > &  q,
const Quaternion< T > &  p 
)
inline

Subtracts p from q.

Note
q.v - p.v, q.r - p.r
Template Parameters
T
Parameters
q
p
Returns

◆ operator/()

template<typename T >
HERMES_DEVICE_CALLABLE Quaternion<T> hermes::operator/ ( const Quaternion< T > &  q,
T  s 
)
inline

Scalar division.

Template Parameters
T
Parameters
q
s
Returns

◆ operator<<()

template<typename T >
std::ostream& hermes::operator<< ( std::ostream &  os,
const Quaternion< T > &  v 
)

Quaternion support for std::ostream::<< operator.

Template Parameters
T
Parameters
os
v
Returns