rcpp_math.hpp File Reference

The Rcpp interface to declare different mathematical functions that are written in C++ but can be used within R. More...

#include "rcpp_interface_base.hpp"
#include "../../../common/fims_math.hpp"

Go to the source code of this file.

Functions
double	logit_rcpp (double a, double b, double x)
	A rcpp interface to the logit function.
double	inv_logit_rcpp (double a, double b, double logit_x)
	A rcpp interface to the inverse-logit function.

Detailed Description

The Rcpp interface to declare different mathematical functions that are written in C++ but can be used within R.

Copyright

This file is part of the NOAA, National Marine Fisheries Service Fisheries Integrated Modeling System project. See LICENSE in the source folder for reuse information.

Function Documentation

inv_logit_rcpp()

double inv_logit_rcpp	(	double	a,
		double	b,
		double	logit_x
	)

A rcpp interface to the inverse-logit function.

Parameters

a	Lower bound of the logit function, typically 0.0.
b	Upper bound of the logit function, typically 1.0.
logit_x	A single numeric value (double) in real space.

Returns

A double in the bounded space rather than real space.

logit_rcpp()

double logit_rcpp	(	double	a,
		double	b,
		double	x
	)

A rcpp interface to the logit function.

Parameters

a	Lower bound of the logit function, typically 0.0.
b	Upper bound of the logit function, typically 1.0.
x	A single numeric value (double) to be transformed on the real line.

Returns

A double in real space rather than the bounded space.