pdf1d_exponential_builder Class Reference

Class to build pdf1d_exponential objects. More...

#include <pdf1d_exponential_builder.h>

Inheritance diagram for pdf1d_exponential_builder:

List of all members.

Public Member Functions
	pdf1d_exponential_builder ()
	Dflt ctor.
virtual	~pdf1d_exponential_builder ()
	Destructor.
virtual pdf1d_pdf *	new_model () const
	Create empty model.
virtual vcl_string	new_model_type () const
	Name of the model class returned by new_model().
virtual void	set_min_var (double min_var)
	Define lower threshold on variance for built models.
virtual double	min_var () const
	Get lower threshold on variance for built models.
virtual void	build_from_array (pdf1d_pdf &model, const double *data, int n) const
	Build exponential from n elements in data[i].
virtual void	build (pdf1d_pdf &model, double mean) const
	Build default model with given mean.
virtual void	build (pdf1d_pdf &model, mbl_data_wrapper< double > &data) const
	Build model from data.
virtual void	weighted_build (pdf1d_pdf &model, mbl_data_wrapper< double > &data, const vcl_vector< double > &wts) const
	Build model from weighted data.
short	version_no () const
	Version number for I/O.
virtual vcl_string	is_a () const
	Name of the class.
virtual bool	is_class (vcl_string const &s) const
	Does the name of the class match the argument?.
virtual pdf1d_builder *	clone () const
	Create a copy on the heap and return base class pointer.
virtual void	print_summary (vcl_ostream &os) const
	Print class to os.
virtual void	b_write (vsl_b_ostream &bfs) const
	Save class to binary file stream.
virtual void	b_read (vsl_b_istream &bfs)
	Load class from binary file stream.
Private Member Functions
pdf1d_exponential &	exponential (pdf1d_pdf &model) const
Private Attributes
double	min_var_

---

Detailed Description

Class to build pdf1d_exponential objects.

Definition at line 18 of file pdf1d_exponential_builder.h.

---

Constructor & Destructor Documentation

pdf1d_exponential_builder::pdf1d_exponential_builder

(

)

Dflt ctor.

Definition at line 22 of file pdf1d_exponential_builder.cxx.

pdf1d_exponential_builder::~pdf1d_exponential_builder

(

)

[virtual]

Destructor.

Definition at line 31 of file pdf1d_exponential_builder.cxx.

---

Member Function Documentation

void pdf1d_exponential_builder::b_read

(

vsl_b_istream &

bfs

)

[virtual]

Load class from binary file stream.

Implements pdf1d_builder.

Definition at line 228 of file pdf1d_exponential_builder.cxx.

void pdf1d_exponential_builder::b_write

(

vsl_b_ostream &

bfs

)

const [virtual]

Save class to binary file stream.

Implements pdf1d_builder.

Definition at line 218 of file pdf1d_exponential_builder.cxx.

void pdf1d_exponential_builder::build	(	pdf1d_pdf &	model,
		double	mean
	)		const [virtual]

Build default model with given mean.

Implements pdf1d_builder.

Definition at line 69 of file pdf1d_exponential_builder.cxx.

void pdf1d_exponential_builder::build	(	pdf1d_pdf &	model,
		mbl_data_wrapper< double > &	data
	)		const [virtual]

Build model from data.

Implements pdf1d_builder.

Definition at line 95 of file pdf1d_exponential_builder.cxx.

void pdf1d_exponential_builder::build_from_array	(	pdf1d_pdf &	model,
		const double *	data,
		int	n
	)		const [virtual]

Build exponential from n elements in data[i].

Reimplemented from pdf1d_builder.

Definition at line 76 of file pdf1d_exponential_builder.cxx.

pdf1d_builder * pdf1d_exponential_builder::clone

(

)

const [virtual]

Create a copy on the heap and return base class pointer.

Implements pdf1d_builder.

Definition at line 200 of file pdf1d_exponential_builder.cxx.

pdf1d_exponential & pdf1d_exponential_builder::exponential

(

pdf1d_pdf &

model

)

const [private]

Definition at line 37 of file pdf1d_exponential_builder.cxx.

vcl_string pdf1d_exponential_builder::is_a

(

)

const [virtual]

Name of the class.

Reimplemented from pdf1d_builder.

Definition at line 173 of file pdf1d_exponential_builder.cxx.

bool pdf1d_exponential_builder::is_class

(

vcl_string const &

s

)

const [virtual]

Does the name of the class match the argument?.

Reimplemented from pdf1d_builder.

Definition at line 182 of file pdf1d_exponential_builder.cxx.

double pdf1d_exponential_builder::min_var

(

)

const [virtual]

Get lower threshold on variance for built models.

Implements pdf1d_builder.

Definition at line 64 of file pdf1d_exponential_builder.cxx.

pdf1d_pdf * pdf1d_exponential_builder::new_model

(

)

const [virtual]

Create empty model.

Implements pdf1d_builder.

Definition at line 44 of file pdf1d_exponential_builder.cxx.

vcl_string pdf1d_exponential_builder::new_model_type

(

)

const [virtual]

Name of the model class returned by new_model().

Implements pdf1d_builder.

Definition at line 49 of file pdf1d_exponential_builder.cxx.

void pdf1d_exponential_builder::print_summary

(

vcl_ostream &

os

)

const [virtual]

Print class to os.

Implements pdf1d_builder.

Definition at line 209 of file pdf1d_exponential_builder.cxx.

void pdf1d_exponential_builder::set_min_var

(

double

min_var

)

[virtual]

Define lower threshold on variance for built models.

Implements pdf1d_builder.

Definition at line 57 of file pdf1d_exponential_builder.cxx.

short pdf1d_exponential_builder::version_no

(

)

const

Version number for I/O.

Reimplemented from pdf1d_builder.

Definition at line 191 of file pdf1d_exponential_builder.cxx.

void pdf1d_exponential_builder::weighted_build	(	pdf1d_pdf &	model,
		mbl_data_wrapper< double > &	data,
		const vcl_vector< double > &	wts
	)		const [virtual]

Build model from weighted data.

Implements pdf1d_builder.

Definition at line 132 of file pdf1d_exponential_builder.cxx.

---

Member Data Documentation

double pdf1d_exponential_builder::min_var_ [private]

Definition at line 20 of file pdf1d_exponential_builder.h.

---

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

• contrib/mul/pdf1d/pdf1d_exponential_builder.h
• contrib/mul/pdf1d/pdf1d_exponential_builder.cxx