Epok Engine

PSYQO SDK

psyqo::SoftMath::inverseSquareRoot

Function · 2 overloads

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Computes the inverse square root of a fixed point number, given an approximative hint.

Belongs to
psyqo::SoftMath
Header
soft-math.hh
Overloads
2

Declaration 1 of 2

Declaration
FixedPoint<> inverseSquareRoot(FixedPoint<> x, FixedPoint<> y)

Computes the inverse square root of a fixed point number, given an approximative hint.

ParameterTypeMeaning
xFixedPoint<>The number to compute the inverse square root of.
yFixedPoint<>The approximative hint of the result.

Returns: FixedPoint<> — psyqo::FixedPoint<> The inverse square root.

Example sketch

C++ example
#include "psyqo/soft-math.hh"

// Assume these named values have been initialized with valid data:
// FixedPoint<> x
// FixedPoint<> y

auto result = psyqo::SoftMath::inverseSquareRoot(x, y);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/soft-math.hh:202

Declaration 2 of 2

static
Declaration
static inline FixedPoint<> inverseSquareRoot(FixedPoint<> x)

Computes the inverse square root of a fixed point number.

ParameterTypeMeaning
xFixedPoint<>The number to compute the inverse square root of.

Returns: FixedPoint<> — psyqo::FixedPoint<> The inverse square root.

Example sketch

C++ example
#include "psyqo/soft-math.hh"

// Assume these named values have been initialized with valid data:
// FixedPoint<> x

auto result = psyqo::SoftMath::inverseSquareRoot(x);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/soft-math.hh:210

Related members