shz::sincos Struct Reference

#include <shz_trig.hpp>

Inheritance diagram for shz::sincos:

Collaboration diagram for shz::sincos:

Public Member Functions
	sincos (shz_sincos_t val) noexcept
float	sinf () const noexcept
float	cosf () const noexcept
float	tanf () const noexcept
float	secf () const noexcept
float	cscf () const noexcept
float	cotf () const noexcept
	operator std::pair< float, float > () const noexcept

Static Public Member Functions
static sincos	from_radians (float rad) noexcept
static sincos	from_radians (uint16_t rad) noexcept
static sincos	from_degrees (float deg) noexcept

Additional Inherited Members
Data Fields inherited from shz_sincos_t
float	sin
float	cos

Detailed Description

C++ sine/cosine approximation pairs.

This structure contains the precomputed values for both sine and cosine of an angle.

Definition at line 42 of file shz_trig.hpp.

Constructor & Destructor Documentation

sincos()

shz::sincos::sincos ( shz_sincos_t val )

inlinenoexcept

Converting constructor from C struct.

Definition at line 44 of file shz_trig.hpp.

                                                          :
            shz_sincos_t(val) {}

Member Function Documentation

from_radians() [1/2]

static sincos shz::sincos::from_radians ( float rad )

inlinestaticnoexcept

Returns a new sin/cos pair from the given angle in radians.

Definition at line 48 of file shz_trig.hpp.

                                                                        {
            return shz_sincosf(rad);
        }

from_radians() [2/2]

static sincos shz::sincos::from_radians ( uint16_t rad )

inlinestaticnoexcept

Returns a new sin/cos pair from the given 16-bit integer angle in radians.

Definition at line 53 of file shz_trig.hpp.

                                                                           {
            return shz_sincosu16(rad);
        }

from_degrees()

static sincos shz::sincos::from_degrees ( float deg )

inlinestaticnoexcept

Returns a new sin/cos pair from the given angle in degrees.

Definition at line 58 of file shz_trig.hpp.

                                                                        {
            return shz_sincosf_deg(deg);
        }

sinf()

float shz::sincos::sinf ( ) const

inlinenoexcept

Returns the sine component from the pair.

Definition at line 63 of file shz_trig.hpp.

{ return this->sin; }

cosf()

float shz::sincos::cosf ( ) const

inlinenoexcept

Returns the cosine component from the pair.

Definition at line 65 of file shz_trig.hpp.

{ return this->cos; }

tanf()

float shz::sincos::tanf ( ) const

inlinenoexcept

Calculates the tangent from the given pair.

Definition at line 67 of file shz_trig.hpp.

{ return shz_sincos_tanf(*this); }

secf()

float shz::sincos::secf ( ) const

inlinenoexcept

Calculates the secant from the given pair.

Definition at line 69 of file shz_trig.hpp.

{ return shz_sincos_secf(*this); }

cscf()

float shz::sincos::cscf ( ) const

inlinenoexcept

Calculates the cosecant from the given pair.

Definition at line 71 of file shz_trig.hpp.

{ return shz_sincos_cscf(*this); }

cotf()

float shz::sincos::cotf ( ) const

inlinenoexcept

Calculates the cotangent from the given pair.

Definition at line 73 of file shz_trig.hpp.

{ return shz_sincos_cotf(*this); }

operator std::pair< float, float >()

shz::sincos::operator std::pair< float, float > ( ) const

inlinenoexcept

Definition at line 76 of file shz_trig.hpp.

                                                                         { 
            return std::pair(sinf(), cosf());
        }

---

The documentation for this struct was generated from the following file:

• shz_trig.hpp