Arithmetic Functions

Functions

template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::abs (const scalar< S > &value)
 If value is greater than zero, returns value, otherwise, returns -value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::clamp (const scalar< S > &value, const scalar< S > &minimum, const scalar< S > &maximum)
 Clamps value to the range between minimum and maximum.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::clamp (const scalar< S > &value, const scalar< S > &minimum, const typename uncaptured< scalar< S > >::type &maximum)
 Clamps value to the range between minimum and maximum.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::clamp (const scalar< S > &value, const typename uncaptured< scalar< S > >::type &minimum, const scalar< S > &maximum)
 Clamps value to the range between minimum and maximum.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::clamp (const scalar< S > &value, const typename uncaptured< scalar< S > >::type &minimum, const typename uncaptured< scalar< S > >::type &maximum)
 Clamps value to the range between minimum and maximum.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::clamp (const typename uncaptured< scalar< S > >::type &value, const scalar< S > &minimum, const scalar< S > &maximum)
 Clamps value to the range between minimum and maximum.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::clamp (const typename uncaptured< scalar< S > >::type &value, const scalar< S > &minimum, const typename uncaptured< scalar< S > >::type &maximum)
 Clamps value to the range between minimum and maximum.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::clamp (const typename uncaptured< scalar< S > >::type &value, const typename uncaptured< scalar< S > >::type &minimum, const scalar< S > &maximum)
 Clamps value to the range between minimum and maximum.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_fp< scalar
< S > >::value, scalar< S >
>::type 
arbb::rcp (const scalar< S > &value)
 Returns the reciprocal of value (1/x).
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_fp< scalar
< S > >::value, scalar< S >
>::type 
arbb::rsqrt (const scalar< S > &value)
 Returns the reciprocal square root of value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_fp< scalar
< S > >::value, scalar< S >
>::type 
arbb::sqrt (const scalar< S > &value)
 Returns the square root of value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_signed
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator- (const scalar< S > &value)
 Returns the negative of value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator+ (const scalar< S > &a, const scalar< S > &b)
 Adds a to b and returns the result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator+ (const scalar< S > &a, const typename uncaptured< scalar< S > >::type &b)
 Adds a to b and returns the result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator+ (const typename uncaptured< scalar< S > >::type &a, const scalar< S > &b)
 Adds a to b and returns the result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator+= (scalar< S > &value, const scalar< S > &increment)
 Increments value by increment and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator+= (scalar< S > &value, const typename uncaptured< scalar< S > >::type &increment)
 Increments value by increment and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator+= (typename uncaptured< scalar< S > >::type &value, const scalar< S > &increment)
 Increments value by increment and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator/ (const scalar< S > &numerator, const scalar< S > &denominator)
 Returns numerator divided by denominator.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator/ (const scalar< S > &numerator, const typename uncaptured< scalar< S > >::type &denominator)
 Returns numerator divided by denominator.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator/ (const typename uncaptured< scalar< S > >::type &numerator, const scalar< S > &denominator)
 Returns numerator divided by denominator.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator/= (scalar< S > &value, const scalar< S > &denominator)
 Sets value to value divided by denominator and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator/= (scalar< S > &value, const typename uncaptured< scalar< S > >::type &denominator)
 Sets value to value divided by denominator and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator/= (typename uncaptured< scalar< S > >::type &value, const scalar< S > &denominator)
 Sets value to value divided by denominator and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_fp< scalar
< S > >::value, scalar< S >
>::type 
arbb::div_tan (const scalar< S > &x, const scalar< S > &y)
 Returns tan(y / x).
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_fp< scalar
< S > >::value, scalar< S >
>::type 
arbb::div_tan (const scalar< S > &x, const typename uncaptured< scalar< S > >::type &y)
 Returns tan(y / x).
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_fp< scalar
< S > >::value, scalar< S >
>::type 
arbb::div_tan (const typename uncaptured< scalar< S > >::type &x, const scalar< S > &y)
 Returns tan(y / x).
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_int
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator% (const scalar< S > &dividend, const scalar< S > &divisor)
 Returns the remainder of dividend divided by divisor.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_int
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator% (const scalar< S > &dividend, const typename uncaptured< scalar< S > >::type &divisor)
 Returns the remainder of dividend divided by divisor.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_int
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator% (const typename uncaptured< scalar< S > >::type &dividend, const scalar< S > &divisor)
 Returns the remainder of dividend divided by divisor.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_int
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator%= (scalar< S > &value, const scalar< S > &divisor)
 Modifies value by storing in it the remainder of value divided by divisor and returns the modified result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_int
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator%= (scalar< S > &value, const typename uncaptured< scalar< S > >::type &divisor)
 Modifies value by storing in it the remainder of value divided by divisor and returns the modified result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_int
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator%= (typename uncaptured< scalar< S > >::type &value, const scalar< S > &divisor)
 Modifies value by storing in it the remainder of value divided by divisor and returns the modified result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator* (const scalar< S > &a, const scalar< S > &b)
 Multiplies a with b and returns the result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator* (const scalar< S > &a, const typename uncaptured< scalar< S > >::type &b)
 Multiplies a with b and returns the result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator* (const typename uncaptured< scalar< S > >::type &a, const scalar< S > &b)
 Multiplies a with b and returns the result.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator*= (scalar< S > &value, const scalar< S > &multiplicand)
 Modifies value by multiplying it by multiplicand and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator*= (scalar< S > &value, const typename uncaptured< scalar< S > >::type &multiplicand)
 Modifies value by multiplying it by multiplicand and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator*= (typename uncaptured< scalar< S > >::type &value, const scalar< S > &multiplicand)
 Modifies value by multiplying it by multiplicand and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator- (const scalar< S > &value, const scalar< S > &amount)
 Returns value subtracted by amount.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator- (const scalar< S > &value, const typename uncaptured< scalar< S > >::type &amount)
 Returns value subtracted by amount.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator- (const typename uncaptured< scalar< S > >::type &value, const scalar< S > &amount)
 Returns value subtracted by amount.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator-= (scalar< S > &value, const scalar< S > &amount)
 Modifies value by subtracting it by amount and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator-= (scalar< S > &value, const typename uncaptured< scalar< S > >::type &amount)
 Modifies value by subtracting it by amount and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator-= (typename uncaptured< scalar< S > >::type &value, const scalar< S > &amount)
 Modifies value by subtracting it by amount and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator++ (scalar< S > &value)
 Modifies value by adding 1 to it and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator++ (scalar< S > &value, int)
 Modifies value by adding 1 to it and returns a copy of the original value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > & >::type 
arbb::operator-- (scalar< S > &value)
 Modifies value by subtracting 1 from it and returns the modified value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
< detail::is_scalar_boolean
< scalar< S > >::value, scalar
< S > >::type 
arbb::operator-- (scalar< S > &value, int)
 Modifies value by subtracting 1 from it and returns a copy of the original value.
template<arbb_scalar_type_t S>
arbb::detail::disable_if
<!detail::is_scalar_unsigned_int
< scalar< S > >::value,
typename detail::signed_type
< scalar< S > >::type >::type 
arbb::operator- (scalar< S > &value)
 Returns the negative of value.

Function Documentation

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::abs ( const scalar< S > &  value  )  [inline]

If value is greater than zero, returns value, otherwise, returns -value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The floating-point value whose absolute value is returned.

Definition at line 48 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::clamp ( const scalar< S > &  value,
const scalar< S > &  minimum,
const scalar< S > &  maximum 
) [inline]

Clamps value to the range between minimum and maximum.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be clamped.
minimum The minimum value returned.
maximum The maximum value returned.

Definition at line 154 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::clamp ( const scalar< S > &  value,
const scalar< S > &  minimum,
const typename uncaptured< scalar< S > >::type &  maximum 
) [inline]

Clamps value to the range between minimum and maximum.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be clamped.
minimum The minimum value returned.
maximum The maximum value returned.

Definition at line 177 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::clamp ( const scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  minimum,
const scalar< S > &  maximum 
) [inline]

Clamps value to the range between minimum and maximum.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be clamped.
minimum The minimum value returned.
maximum The maximum value returned.

Definition at line 201 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::clamp ( const scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  minimum,
const typename uncaptured< scalar< S > >::type &  maximum 
) [inline]

Clamps value to the range between minimum and maximum.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be clamped.
minimum The minimum value returned.
maximum The maximum value returned.

Definition at line 225 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::clamp ( const typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  minimum,
const scalar< S > &  maximum 
) [inline]

Clamps value to the range between minimum and maximum.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be clamped.
minimum The minimum value returned.
maximum The maximum value returned.

Definition at line 250 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::clamp ( const typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  minimum,
const typename uncaptured< scalar< S > >::type &  maximum 
) [inline]

Clamps value to the range between minimum and maximum.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be clamped.
minimum The minimum value returned.
maximum The maximum value returned.

Definition at line 274 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::clamp ( const typename uncaptured< scalar< S > >::type &  value,
const typename uncaptured< scalar< S > >::type &  minimum,
const scalar< S > &  maximum 
) [inline]

Clamps value to the range between minimum and maximum.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be clamped.
minimum The minimum value returned.
maximum The maximum value returned.

Definition at line 299 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_fp< scalar<S> >::value, scalar<S> >::type arbb::rcp ( const scalar< S > &  value  )  [inline]

Returns the reciprocal of value (1/x).

This function only applies to scalars of floating point type (arbb::f32 or arbb::f64).

Parameters:

value The floating-point value whose reciprocal is returned.

Definition at line 531 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_fp< scalar<S> >::value, scalar<S> >::type arbb::rsqrt ( const scalar< S > &  value  )  [inline]

Returns the reciprocal square root of value.

This function only applies to scalars of floating point type (arbb::f32 or arbb::f64).

Parameters:

value The floating-point value whose reciprocal square root is returned.

Definition at line 583 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_fp< scalar<S> >::value, scalar<S> >::type arbb::sqrt ( const scalar< S > &  value  )  [inline]

Returns the square root of value.

This function only applies to scalars of floating point type (arbb::f32 or arbb::f64).

Parameters:

value The floating-point value whose square root is returned.

Definition at line 661 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_signed< scalar<S> >::value, scalar<S> >::type arbb::operator- ( const scalar< S > &  value  )  [inline]

Returns the negative of value.

This function applies to scalars of floating point type and signed integral type (arbb::i8, arbb::i32, arbb::i64, arbb::f32, arbb::f64).

Parameters:

value The value whose negative is returned.

Definition at line 791 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator+ ( const scalar< S > &  a,
const scalar< S > &  b 
) [inline]

Adds a to b and returns the result.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

a The first value to be added.
b The second value to be added.

Definition at line 818 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator+ ( const scalar< S > &  a,
const typename uncaptured< scalar< S > >::type &  b 
) [inline]

Adds a to b and returns the result.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

a The first value to be added.
b The second value to be added.

Definition at line 844 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator+ ( const typename uncaptured< scalar< S > >::type &  a,
const scalar< S > &  b 
) [inline]

Adds a to b and returns the result.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

a The first value to be added.
b The second value to be added.

Definition at line 871 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator+= ( scalar< S > &  value,
const scalar< S > &  increment 
) [inline]

Increments value by increment and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be incremented.
increment The amount by which to increment.

Definition at line 899 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator+= ( scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  increment 
) [inline]

Increments value by increment and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be incremented.
increment The amount by which to increment.

Definition at line 924 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator+= ( typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  increment 
) [inline]

Increments value by increment and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be incremented.
increment The amount by which to increment.

Definition at line 950 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator/ ( const scalar< S > &  numerator,
const scalar< S > &  denominator 
) [inline]

Returns numerator divided by denominator.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

numerator The numerator of the division.
denominator The denominator of the division.

Definition at line 1301 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator/ ( const scalar< S > &  numerator,
const typename uncaptured< scalar< S > >::type &  denominator 
) [inline]

Returns numerator divided by denominator.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

numerator The numerator of the division.
denominator The denominator of the division.

Definition at line 1327 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator/ ( const typename uncaptured< scalar< S > >::type &  numerator,
const scalar< S > &  denominator 
) [inline]

Returns numerator divided by denominator.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

numerator The numerator of the division.
denominator The denominator of the division.

Definition at line 1354 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator/= ( scalar< S > &  value,
const scalar< S > &  denominator 
) [inline]

Sets value to value divided by denominator and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be divided.
denominator The denominator of the division.

Definition at line 1382 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator/= ( scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  denominator 
) [inline]

Sets value to value divided by denominator and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be divided.
denominator The denominator of the division.

Definition at line 1407 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator/= ( typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  denominator 
) [inline]

Sets value to value divided by denominator and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be divided.
denominator The denominator of the division.

Definition at line 1433 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_fp< scalar<S> >::value, scalar<S> >::type arbb::div_tan ( const scalar< S > &  x,
const scalar< S > &  y 
) [inline]

Returns tan(y / x).

This function only applies to scalars of floating point type (arbb::f32 or arbb::f64).

Parameters:

x The denominator of the tangent expression evaluated.
y The numerator of the tangent expression evaluated.

Definition at line 1460 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_fp< scalar<S> >::value, scalar<S> >::type arbb::div_tan ( const scalar< S > &  x,
const typename uncaptured< scalar< S > >::type &  y 
) [inline]

Returns tan(y / x).

This function only applies to scalars of floating point type (arbb::f32 or arbb::f64).

Parameters:

x The denominator of the tangent expression evaluated.
y The numerator of the tangent expression evaluated.

Definition at line 1486 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_fp< scalar<S> >::value, scalar<S> >::type arbb::div_tan ( const typename uncaptured< scalar< S > >::type &  x,
const scalar< S > &  y 
) [inline]

Returns tan(y / x).

This function only applies to scalars of floating point type (arbb::f32 or arbb::f64).

Parameters:

x The denominator of the tangent expression evaluated.
y The numerator of the tangent expression evaluated.

Definition at line 1513 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_int< scalar<S> >::value, scalar<S> >::type arbb::operator% ( const scalar< S > &  dividend,
const scalar< S > &  divisor 
) [inline]

Returns the remainder of dividend divided by divisor.

This function only applies to scalars of integral type (arbb::i8, arbb::i16, arbb::i32, arbb::i64, arbb::u8, arbb::u16, arbb::u32, arbb::u64).

Parameters:

dividend The dividend from which the remainder is calculated.
divisor The divisor by which the dividend is divided to calculate the remainder.

Definition at line 2544 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_int< scalar<S> >::value, scalar<S> >::type arbb::operator% ( const scalar< S > &  dividend,
const typename uncaptured< scalar< S > >::type &  divisor 
) [inline]

Returns the remainder of dividend divided by divisor.

This function only applies to scalars of integral type (arbb::i8, arbb::i16, arbb::i32, arbb::i64, arbb::u8, arbb::u16, arbb::u32, arbb::u64).

Parameters:

dividend The dividend from which the remainder is calculated.
divisor The divisor by which the dividend is divided to calculate the remainder.

Definition at line 2571 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_int< scalar<S> >::value, scalar<S> >::type arbb::operator% ( const typename uncaptured< scalar< S > >::type &  dividend,
const scalar< S > &  divisor 
) [inline]

Returns the remainder of dividend divided by divisor.

This function only applies to scalars of integral type (arbb::i8, arbb::i16, arbb::i32, arbb::i64, arbb::u8, arbb::u16, arbb::u32, arbb::u64).

Parameters:

dividend The dividend from which the remainder is calculated.
divisor The divisor by which the dividend is divided to calculate the remainder.

Definition at line 2599 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_int< scalar<S> >::value, scalar<S>& >::type arbb::operator%= ( scalar< S > &  value,
const scalar< S > &  divisor 
) [inline]

Modifies value by storing in it the remainder of value divided by divisor and returns the modified result.

This function only applies to scalars of integral type (arbb::i8, arbb::i16, arbb::i32, arbb::i64, arbb::u8, arbb::u16, arbb::u32, arbb::u64).

Parameters:

value The value that stores the dividend and the calculated result.
divisor The divisor by which the dividend is divided to calculate the remainder.

Definition at line 2628 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_int< scalar<S> >::value, scalar<S>& >::type arbb::operator%= ( scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  divisor 
) [inline]

Modifies value by storing in it the remainder of value divided by divisor and returns the modified result.

This function only applies to scalars of integral type (arbb::i8, arbb::i16, arbb::i32, arbb::i64, arbb::u8, arbb::u16, arbb::u32, arbb::u64).

Parameters:

value The value that stores the dividend and the calculated result.
divisor The divisor by which the dividend is divided to calculate the remainder.

Definition at line 2654 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_int< scalar<S> >::value, scalar<S>& >::type arbb::operator%= ( typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  divisor 
) [inline]

Modifies value by storing in it the remainder of value divided by divisor and returns the modified result.

This function only applies to scalars of integral type (arbb::i8, arbb::i16, arbb::i32, arbb::i64, arbb::u8, arbb::u16, arbb::u32, arbb::u64).

Parameters:

value The value that stores the dividend and the calculated result.
divisor The divisor by which the dividend is divided to calculate the remainder.

Definition at line 2681 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator* ( const scalar< S > &  a,
const scalar< S > &  b 
) [inline]

Multiplies a with b and returns the result.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

a The first value to be multiplied.
b The second value to be multiplied.

Definition at line 2708 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator* ( const scalar< S > &  a,
const typename uncaptured< scalar< S > >::type &  b 
) [inline]

Multiplies a with b and returns the result.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

a The first value to be multiplied.
b The second value to be multiplied.

Definition at line 2734 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator* ( const typename uncaptured< scalar< S > >::type &  a,
const scalar< S > &  b 
) [inline]

Multiplies a with b and returns the result.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

a The first value to be multiplied.
b The second value to be multiplied.

Definition at line 2761 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator*= ( scalar< S > &  value,
const scalar< S > &  multiplicand 
) [inline]

Modifies value by multiplying it by multiplicand and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be multiplied.
multiplicand The amount by which to multiply.

Definition at line 2789 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator*= ( scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  multiplicand 
) [inline]

Modifies value by multiplying it by multiplicand and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be multiplied.
multiplicand The amount by which to multiply.

Definition at line 2814 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator*= ( typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  multiplicand 
) [inline]

Modifies value by multiplying it by multiplicand and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be multiplied.
multiplicand The amount by which to multiply.

Definition at line 2840 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator- ( const scalar< S > &  value,
const scalar< S > &  amount 
) [inline]

Returns value subtracted by amount.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value from which to subtract.
amount The amount to be subtracted.

Definition at line 3167 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator- ( const scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  amount 
) [inline]

Returns value subtracted by amount.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value from which to subtract.
amount The amount to be subtracted.

Definition at line 3193 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator- ( const typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  amount 
) [inline]

Returns value subtracted by amount.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value from which to subtract.
amount The amount to be subtracted.

Definition at line 3220 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator-= ( scalar< S > &  value,
const scalar< S > &  amount 
) [inline]

Modifies value by subtracting it by amount and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value from which to subtract.
amount The amount to be subtracted.

Definition at line 3248 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator-= ( scalar< S > &  value,
const typename uncaptured< scalar< S > >::type &  amount 
) [inline]

Modifies value by subtracting it by amount and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value from which to subtract.
amount The amount to be subtracted.

Definition at line 3273 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator-= ( typename uncaptured< scalar< S > >::type &  value,
const scalar< S > &  amount 
) [inline]

Modifies value by subtracting it by amount and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value from which to subtract.
amount The amount to be subtracted.

Definition at line 3299 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator++ ( scalar< S > &  value  )  [inline]

Modifies value by adding 1 to it and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be incremented.

Definition at line 3654 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator++ ( scalar< S > &  value,
int   
) [inline]

Modifies value by adding 1 to it and returns a copy of the original value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be incremented.

Definition at line 3680 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S>& >::type arbb::operator-- ( scalar< S > &  value  )  [inline]

Modifies value by subtracting 1 from it and returns the modified value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be incremented.

Definition at line 3708 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<detail::is_scalar_boolean< scalar<S> >::value, scalar<S> >::type arbb::operator-- ( scalar< S > &  value,
int   
) [inline]

Modifies value by subtracting 1 from it and returns a copy of the original value.

This function applies to any scalars except for booleans (arbb::boolean).

Parameters:

value The value to be incremented.

Definition at line 3734 of file scalar_funcs.hpp.

template<arbb_scalar_type_t S>
arbb ::detail::disable_if<!detail::is_scalar_unsigned_int< scalar<S> >::value, typename detail::signed_type< scalar<S> >::type>::type arbb::operator- ( scalar< S > &  value  )  [inline]

Returns the negative of value.

This function applies to scalars of unsigned integral type. (arbb::u8, arbb::u16, arbb::u32, arbb::u64).

Parameters:

value The value whose negative is returned.

Definition at line 3812 of file scalar_funcs.hpp.

Submit feedback on this help topic

Copyright © 2010, Intel Corporation. All rights reserved.