rcpp_interface_base.hpp File Reference

The Rcpp interface to declare objects that are used ubiquitously throughout the Rcpp interface, e.g., Parameters and ParameterVectors. More...

#include <RcppCommon.h>
#include <map>
#include <vector>
#include "../../../common/def.hpp"
#include "../../../common/information.hpp"
#include "../../interface.hpp"
#include "rcpp_shared_primitive.hpp"
#include <limits>
#include <Rcpp.h>

Go to the source code of this file.

Classes
class	Parameter
	An Rcpp interface that defines the Parameter class. More...
class	ParameterVector
	An Rcpp interface class that defines the ParameterVector class. More...
class	RealVector
	An Rcpp interface class that defines the RealVector class. More...
class	FIMSRcppInterfaceBase
	Base class for all interface objects. More...

Functions
double	sanitize_val (double x)
	Sanitize a double value by replacing NaN or Inf with -999.0.
std::ostream &	operator<< (std::ostream &out, const Parameter &p)
	Output for std::ostream& for a parameter.
std::ostream &	operator<< (std::ostream &out, ParameterVector &v)
	Output for std::ostream& for a ParameterVector.

Detailed Description

The Rcpp interface to declare objects that are used ubiquitously throughout the Rcpp interface, e.g., Parameters and ParameterVectors.

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

operator<<() [1/2]

std::ostream & operator<<	(	std::ostream &	out,
		const Parameter &	p
	)

Output for std::ostream& for a parameter.

Parameters

out	The stream.
p	A parameter.

Returns

std::ostream&

operator<<() [2/2]

std::ostream & operator<<	(	std::ostream &	out,
		ParameterVector &	v
	)

Output for std::ostream& for a ParameterVector.

Parameters

out	The stream.
v	A ParameterVector.

Returns

std::ostream&

sanitize_val()

double sanitize_val ( double  x )

inline

Sanitize a double value by replacing NaN or Inf with -999.0.

Parameters

x	The input double value.

Returns

The sanitized double value.