ADMB Documentation: param_init_bounded_number_vector Class Reference

ADMB Documentation -a65f1c97

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

Class object for init_bounded_number vector. More...

#include <admodel.h>

Public Member Functions
	param_init_bounded_number_vector ()
	Default constructor. More...

	~param_init_bounded_number_vector ()
	Destructor. More...

void	allocate (int min1, int max1, const double_index_type &bmin, const double_index_type &bmax, const index_type &phase_start, const char *s)
	Allocate vector of param_init_bounded_number with dimension [min1 to max1] and bounded by [bmin, bmax]. More...

void	allocate (int min1, int max1, const double_index_type &bmin, const double_index_type &bmax, const char *s)
	Allocate vector of param_init_bounded_number with dimension [min1 to max1] and bounded by [bmin, bmax]. More...

void	allocate (const data_matrix &m, const char *s)
	Overload the allocate function to use a data_matrix object. More...

bool	allocated () const

void	deallocate ()
	Deallocate param_init_bounded_number_vector memory. More...

dvector	get_scalefactor ()

int	indexmax () const

int	indexmin () const

param_init_bounded_number &	operator() (int i)

param_init_bounded_number &	operator[] (int i)

void	set_initial_value (const double_index_type &it)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...

void	set_scalefactor (double s)

void	set_scalefactor (const dvector &s)

Private Attributes
int	index_max

int	index_min

double_index_type *	it

param_init_bounded_number *	v

Detailed Description

Class object for init_bounded_number vector.

Author: Dave Fournier, addition by Steve Martell

Parameters

Steve Martell overloaded the allocate routine to accomodate a matrix object of the form data_matrix that would be read in from an input file.

Definition at line 2915 of file admodel.h.

Constructor & Destructor Documentation

param_init_bounded_number_vector::param_init_bounded_number_vector ( )

Default constructor.

Definition at line 33 of file model48.cpp.

param_init_bounded_number_vector::~param_init_bounded_number_vector ( )

Destructor.

Definition at line 41 of file model48.cpp.

Member Function Documentation

void param_init_bounded_number_vector::allocate	(	int	min1,
		int	max1,
		const double_index_type &	bmin,
		const double_index_type &	bmax,
		const index_type &	phase_start,
		const char *	s
	)

Allocate vector of param_init_bounded_number with dimension [min1 to max1] and bounded by [bmin, bmax].

Parameters

min1	lower vector index
max1	upper vector index
bmin	lower bounds
bmax	upper bounds
phase_start
s	id

Definition at line 108 of file model48.cpp.

Referenced by param_init_bounded_number_matrix::allocate(), and allocate().

void param_init_bounded_number_vector::allocate	(	int	min1,
		int	max1,
		const double_index_type &	bmin,
		const double_index_type &	bmax,
		const char *	s
	)

Allocate vector of param_init_bounded_number with dimension [min1 to max1] and bounded by [bmin, bmax].

Note: phase_start is defaulted to 1.

Parameters

min1	lower vector index
max1	upper vector index
bmin	lower bounds
bmax	upper bounds
s	id

Definition at line 88 of file model48.cpp.

void param_init_bounded_number_vector::allocate	(	const data_matrix &	m,
		const char *	s
	)

Overload the allocate function to use a data_matrix object.

Author: Steve Martell

Definition at line 66 of file model48.cpp.

bool param_init_bounded_number_vector::allocated ( void ) const

inline

Definition at line 2942 of file admodel.h.

void param_init_bounded_number_vector::deallocate ( void )

Deallocate param_init_bounded_number_vector memory.

Definition at line 46 of file model48.cpp.

Referenced by param_init_bounded_number_matrix::deallocate(), and ~param_init_bounded_number_vector().

dvector param_init_bounded_number_vector::get_scalefactor ( void )

Definition at line 263 of file model48.cpp.

Referenced by param_init_bounded_number_matrix::get_scalefactor().

int param_init_bounded_number_vector::indexmax ( void ) const

inline

Definition at line 2944 of file admodel.h.

Referenced by allocate(), dvar_vector::dvar_vector(), param_init_bounded_number_matrix::get_scalefactor(), get_scalefactor(), set_initial_value(), and set_scalefactor().

int param_init_bounded_number_vector::indexmin ( void ) const

inline

Definition at line 2943 of file admodel.h.

Referenced by allocate(), deallocate(), dvar_vector::dvar_vector(), param_init_bounded_number_matrix::get_scalefactor(), get_scalefactor(), set_initial_value(), and set_scalefactor().

param_init_bounded_number & param_init_bounded_number_vector::operator() ( int i )

inline

Definition at line 2955 of file admodel.h.

param_init_bounded_number & param_init_bounded_number_vector::operator[] ( int i )

inline

Definition at line 2950 of file admodel.h.

void param_init_bounded_number_vector::set_initial_value ( const double_index_type & initial_value )

Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California.

Sets the initial value for elements of param_init_bounded_vector.

Parameters

initial_value double

Definition at line 12 of file model48.cpp.

void param_init_bounded_number_vector::set_scalefactor ( double s )

Definition at line 291 of file model48.cpp.

Referenced by param_init_bounded_number_matrix::set_scalefactor(), and set_scalefactor().

void param_init_bounded_number_vector::set_scalefactor ( const dvector & s )

Definition at line 274 of file model48.cpp.

Member Data Documentation

int param_init_bounded_number_vector::index_max

private

Definition at line 2919 of file admodel.h.

Referenced by allocate(), deallocate(), and indexmax().

int param_init_bounded_number_vector::index_min

private

Definition at line 2918 of file admodel.h.

Referenced by allocate(), deallocate(), and indexmin().

double_index_type* param_init_bounded_number_vector::it

private

Definition at line 2920 of file admodel.h.

Referenced by allocate(), deallocate(), and set_initial_value().

param_init_bounded_number* param_init_bounded_number_vector::v

private

Definition at line 2917 of file admodel.h.

Referenced by allocate(), allocated(), deallocate(), operator()(), operator[](), and set_initial_value().

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