offset_multiplier_free() [1/5]

template<typename T , typename M , typename S >

auto stan::math::offset_multiplier_free ( const T &  y, const M &  mu, const S &  sigma  )

inline

Return the unconstrained variable that transforms to the specified offset and multiplier constrained variable given the specified offset and multiplier.

The transform in locmultiplier_constrain(T, double, double), is reversed by the reverse affine transformation,

\(f^{-1}(y) = \frac{y - L}{S}\)

where \(L\) and \(S\) are the offset and multiplier.

If the offset is zero and multiplier is one, this function reduces to identity_free(y).

Template Parameters

T	type of constrained variable
L	type of offset
S	type of multiplier

Parameters

	y	constrained value
[in]	mu	offset of constrained output
[in]	sigma	multiplier of constrained output

Returns

the unconstrained variable that transforms to the given constrained variable given the offset and multiplier

Exceptions

std::domain_error	if sigma <= 0
std::domain_error	if mu is not finite
std::invalid_argument	if non-scalar arguments don't match in size

Definition at line 42 of file offset_multiplier_free.hpp.