Density::Gaussian_params Class Reference

Parameters for a Gaussian density function. More...

#include <density.h>

List of all members.

Public Member Functions
	Gaussian_params (float mu=0, float sigma=1, float min=0, float max=0) throw (jwscxx::base::Arg_error)
	Creates a set of parameters for a Gaussian density function.
virtual	~Gaussian_params ()
	Destructor.
void	set (float mu, float sigma, float min, float max) throw (jwscxx::base::Arg_error)
	Sets the density parameters.
float	get_mu () const
	Returns the mean parameter.
float	get_sigma () const
	Returns the standard deviation parameter.
float	get_min () const
	Returns the minimum value parameter.
float	get_max () const
	Returns the maximum value parameter.
Protected Attributes
float	mu
	Mean value.
float	sigma
	Standard deviation.
float	min
	Minimum value.
float	max
	Maximum value.
Friends
std::ostream &	operator<< (std::ostream &, const Gaussian_params &)
	Prints the Gaussian_params to an output stream.
std::istream &	operator>> (std::istream &, Gaussian_params &)
	Reads this Gaussian_params into an input stream.

---

Detailed Description

Parameters for a Gaussian density function.

Definition at line 117 of file density.h.

---

Constructor & Destructor Documentation

Density::Gaussian_params::Gaussian_params	(	float	mu = 0,
		float	sigma = 1,
		float	min = 0,
		float	max = 0
	)		throw (jwscxx::base::Arg_error)

Creates a set of parameters for a Gaussian density function.

Parameters:

mu	Mean value.
sigma	Standard deviation.
min	Minimum value.
max	Maximum value.

Exceptions:

jwscxx::base::Arg_error

Parameters are not a valid range or sigma is too small.

Definition at line 130 of file density.cpp.

virtual Density::Gaussian_params::~Gaussian_params

(

)

[inline, virtual]

Destructor.

Definition at line 135 of file density.h.

---

Member Function Documentation

void Density::Gaussian_params::set	(	float	mu,
		float	sigma,
		float	min,
		float	max
	)		throw (jwscxx::base::Arg_error)

Sets the density parameters.

Parameters:

mu	Mean value.
sigma	Standard deviation.
min	Minimum value.
max	Maximum value.

Exceptions:

jwscxx::base::Arg_error

Parameters are not a valid range or sigma is too small.

Definition at line 152 of file density.cpp.

float Density::Gaussian_params::get_mu

(

)

const [inline]

Returns the mean parameter.

Definition at line 150 of file density.h.

float Density::Gaussian_params::get_sigma

(

)

const [inline]

Returns the standard deviation parameter.

Definition at line 154 of file density.h.

float Density::Gaussian_params::get_min

(

)

const [inline]

Returns the minimum value parameter.

Definition at line 158 of file density.h.

float Density::Gaussian_params::get_max

(

)

const [inline]

Returns the maximum value parameter.

Definition at line 162 of file density.h.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	,
		const Gaussian_params &
	)		[friend]

Prints the Gaussian_params to an output stream.

std::istream& operator>>	(	std::istream &	,
		Gaussian_params &
	)		[friend]

Reads this Gaussian_params into an input stream.

---

Member Data Documentation

float Density::Gaussian_params::mu [protected]

Mean value.

Definition at line 176 of file density.h.

float Density::Gaussian_params::sigma [protected]

Standard deviation.

Definition at line 179 of file density.h.

float Density::Gaussian_params::min [protected]

Minimum value.

Definition at line 182 of file density.h.

float Density::Gaussian_params::max [protected]

Maximum value.

Definition at line 185 of file density.h.

---

The documentation for this class was generated from the following files:

• density.h
• density.cpp