versor  3.0
C++11 library for Geometric algebra
Typedefs | Functions
Shorthand Syntax

three-letter codes for faster typing and backwards compatibility More...

Typedefs

using vsr::cga::Sca = NSca< 5 >
 Scalar
 
using vsr::cga::Vec = NVec< 5 >
 Vector
 
using vsr::cga::Biv = NBiv< 5 >
 Bivector
 
using vsr::cga::Rot = NRot< 5 >
 Rotor
 
using vsr::cga::Tri = NTri< 5 >
 Trivector
 
using vsr::cga::Ori = NOri< 5 >
 Origin
 
using vsr::cga::Inf = NInf< 5 >
 Infinity
 
using vsr::cga::Mnk = NMnk< 5 >
 Minkowski
 
using vsr::cga::Pss = NPss< 5 >
 Pseudoscalar
 
using vsr::cga::Pnt = NPnt< 5 >
 Point
 
using vsr::cga::Par = NPar< 5 >
 Pair
 
using vsr::cga::Cir = NCir< 5 >
 Circle
 
using vsr::cga::Sph = NSph< 5 >
 Sphere
 
using vsr::cga::Dls = NDls< 5 >
 DualSphere
 
using vsr::cga::Flp = NFlp< 5 >
 FlatPoint
 
using vsr::cga::Dll = NDll< 5 >
 DualLine
 
using vsr::cga::Lin = NLin< 5 >
 Line
 
using vsr::cga::Dlp = NDlp< 5 >
 DualPlane
 
using vsr::cga::Pln = NPln< 5 >
 Plane
 
using vsr::cga::Drv = NDrv< 5 >
 DirectionVector
 
using vsr::cga::Tnv = NTnv< 5 >
 TangentVector
 
using vsr::cga::Drb = NDrb< 5 >
 DirectionBivector
 
using vsr::cga::Tnb = NTnb< 5 >
 TangentBivector
 
using vsr::cga::Drt = NDrt< 5 >
 DirectionTrivector
 
using vsr::cga::Tnt = NTnt< 5 >
 TangentTrivector
 
using vsr::cga::Trs = NTrs< 5 >
 Translator
 
using vsr::cga::Mot = NMot< 5 >
 Motor
 
using vsr::cga::Trv = NTrv< 5 >
 Transversor
 
using vsr::cga::Bst = NBst< 5 >
 Boost
 
using vsr::cga::Con = NCon< 5 >
 ConformalRotor
 
using vsr::cga::Dil = NDil< 5 >
 Dilator
 
using vsr::cga::Tsd = NTsd< 5 >
 TranslatedDilator
 

Functions

template<class A >
static DualSphere vsr::cga::Round::sur (const A &s)
 Dual Surround of a Direct or Dual Round Element (Shorthand) More...
 
template<class A >
static Point vsr::cga::Round::cen (const A &s)
 Simple Center of a Round Element (shorthand) More...
 
template<class A >
static Point vsr::cga::Round::loc (const A &s)
 Location (normalizd) of a Round Element (shorthand) More...
 
template<class A >
static auto vsr::cga::Round::car (const A &s) -> decltype(carrier(s))
 Carrier Flat of Direct? Round Element (Shorthand) More...
 
template<class A >
static auto vsr::cga::Flat::dir (const A &s) -> decltype(direction(s))
 direction shorthand More...
 
template<class A >
static Point vsr::cga::Flat::loc (const A &a, const Point &p, bool dual)
 Location of flat (shorthand)three-letter version of cga::Flat::location. More...
 

Detailed Description

three-letter codes for faster typing and backwards compatibility

Motivation for three-letter codes

The first versions of this software relied on three-letter code words for all the types and functions. That was confusing for some, so documentation is typically written out in longform.

While it is sometimes useful for clarity to write out TangentVector, I find the terseness of Tnv to be sufficiently necessary. Note that this encoding mirrors the shorthand for methods, which also can be written out in longform, as in Gen::transversor or shorthand, as in Gen::trv

See also
Multivector Types

Function Documentation

template<class A >
static auto vsr::cga::Round::car ( const A &  s) -> decltype(carrier(s))
inlinestatic

Carrier Flat of Direct? Round Element (Shorthand)

See also
nga::Round::car for Generic implementation
template<class A >
static Point vsr::cga::Round::cen ( const A &  s)
inlinestatic

Simple Center of a Round Element (shorthand)

See also
nga::Round::cen for Generic implementation
template<class A >
static auto vsr::cga::Flat::dir ( const A &  s) -> decltype( direction(s) )
inlinestatic

direction shorthand

Parameters
sLine or Plane
Returns
a Direction
See also
nga::Flat::dir for Generic implementation
template<class A >
static Point vsr::cga::Round::loc ( const A &  s)
inlinestatic

Location (normalizd) of a Round Element (shorthand)

See also
nga::Round::cen for Generic implementation
template<class A >
static Point vsr::cga::Flat::loc ( const A &  a,
const Point p,
bool  dual 
)
inlinestatic

Location of flat (shorthand)three-letter version of cga::Flat::location.

See also
nga::Flat::loc for the Generic implementation
template<class A >
static DualSphere vsr::cga::Round::sur ( const A &  s)
inlinestatic

Dual Surround of a Direct or Dual Round Element (Shorthand)

See also
nga::Round::sur for Generic implementation