dvar4_array Class Reference

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions
	dvar4_array (int, int)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
	dvar4_array (int hsl, int hsu, int sl, int sh, ivector nrl, ivector nrh, ivector ncl, ivector nch)
	Description not yet available. More...
	dvar4_array (const d4_array &m1)
	Description not yet available. More...
	dvar4_array (const dvar4_array &m2)
	Copy constructor. More...
	dvar4_array (int, int, int, int, int, int, int, int)
	Description not yet available. More...
	dvar4_array (ad_integer, ad_integer, const index_type &, const index_type &, const index_type &, const index_type &, const index_type &, const index_type &)
	Description not yet available. More...
	dvar4_array (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, int nch)
	Description not yet available. More...
	dvar4_array ()
	Default Constructor. More...
	~dvar4_array ()
	Destructor. More...
void	allocate (int hsl, int hsu, int sl, int sh, int nrl, int nrh, int ncl, int nch)
	Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (int hsl, int hsu, int sl, int sh, int nrl, int nrh, const ivector &ncl, const ivector &nch)
	Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (int hsl, int hsu, int sl, int sh, const ivector &nrl, const ivector &nrh, const ivector &ncl, const ivector &nch)
	Allocate array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (ad_integer, ad_integer, const index_type &, const index_type &, const index_type &, const index_type &, const index_type &, const index_type &)
	Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (ad_integer, ad_integer, const index_type &, const index_type &, const index_type &, const index_type &)
	Description not yet available. More...
void	allocate (ad_integer, ad_integer, const index_type &, const index_type &)
	Description not yet available. More...
void	allocate (ad_integer, ad_integer)
	Allocate vector of empty dvar3_array with dimension [hsl to hsu]. More...
void	allocate (void)
	Initializes to NULL. More...
void	allocate (const d4_array &)
	Allocate dvar4_array with same dimensions as m1. More...
void	allocate (const dvar4_array &)
	Allocate dvar4_array with same dimensions as m1. More...
void	allocate (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, int nch)
int	colmax (void)
int	colmax (void) const
int	colmin (void)
int	colmin (void) const
int	colsize ()
int	colsize () const
void	deallocate (void)
	Deallocate dvar4_array memory. More...
dvar3_array &	elem (int i)
dvar_matrix &	elem (int i, int j)
dvar_vector &	elem (int i, int j, int k)
prevariable	elem (int i, int j, int k, int l)
const dvar3_array &	elem (int i) const
const dvar_matrix &	elem (int i, int j) const
const dvar_vector &	elem (int i, int j, int k) const
const prevariable	elem (int i, int j, int k, int l) const
unsigned int	get_ncopies () const
int	hslicemax () const
int	hslicemin () const
unsigned int	hslicesize () const
int	indexmax () const
int	indexmin () const
void	initialize (void)
	Description not yet available. More...
int	operator! (void) const
dvar3_array &	operator() (int i)
dvar_matrix &	operator() (int i, int j)
dvar_vector &	operator() (int i, int j, int k)
prevariable	operator() (int i, int j, int k, int l)
const dvar3_array &	operator() (int i) const
const dvar_matrix &	operator() (int i, int j) const
const dvar_vector &	operator() (int i, int j, int k) const
const prevariable	operator() (int i, int j, int k, int l) const
void	operator/= (const prevariable &d)
	Description not yet available. More...
void	operator/= (const double &d)
	Description not yet available. More...
dvar4_array &	operator= (const d4_array &)
	Description not yet available. More...
dvar4_array &	operator= (const dvar4_array &)
	Description not yet available. More...
dvar3_array &	operator[] (int i)
const dvar3_array &	operator[] (int i) const
int	rowmax (void)
int	rowmax (void) const
int	rowmin (void)
int	rowmin (void) const
int	rowsize ()
int	rowsize () const
void	shallow_copy (const dvar4_array &)
	Shallow copy other data structure pointers. More...
int	slicemax (void)
int	slicemax (void) const
int	slicemin (void)
int	slicemin (void) const
int	slicesize ()
int	slicesize () const
dvar4_array	sub (int, int)
	Description not yet available. More...
d4_array	vale (d4_array &)

Private Attributes
four_array_shape *	shape
dvar3_array *	t

Friends
class	four_array_shape

Detailed Description

Description not yet available.

Parameters

Definition at line 5433 of file fvar.hpp.

Constructor & Destructor Documentation

dvar4_array::dvar4_array	(	int	nrl,
		int	nrh
	)

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

Construct vector of dvar4_array with dimension nrl to nrh.

Parameters

nrl	lower index
nrh	upper index

Definition at line 14 of file f4arr.cpp.

dvar4_array::dvar4_array	(	int	hsl,
		int	hsu,
		int	sl,
		int	sh,
		ivector	nrl,
		ivector	nrh,
		ivector	ncl,
		ivector	nch
	)

Description not yet available.

Parameters

Definition at line 576 of file f4arr.cpp.

dvar4_array::dvar4_array

(

const d4_array &

m1

)

Description not yet available.

Parameters

Definition at line 647 of file f4arr.cpp.

dvar4_array::dvar4_array

(

const dvar4_array &

m2

)

Copy constructor.

Definition at line 19 of file f4arr.cpp.

dvar4_array::dvar4_array	(	int	hsl,
		int	hsu,
		int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Description not yet available.

Parameters

Definition at line 555 of file f4arr.cpp.

dvar4_array::dvar4_array	(	ad_integer	hsl,
		ad_integer	hsu,
		const index_type &	sl,
		const index_type &	sh,
		const index_type &	nrl,
		const index_type &	nrh,
		const index_type &	ncl,
		const index_type &	nch
	)

Description not yet available.

Parameters

Definition at line 565 of file f4arr.cpp.

dvar4_array::dvar4_array	(	int	hsl,
		int	hsu,
		int	sl,
		const ivector &	sh,
		int	nrl,
		const imatrix &	nrh,
		int	ncl,
		int	nch
	)

Description not yet available.

Parameters

Definition at line 605 of file f4arr.cpp.

dvar4_array::dvar4_array

(

)

Default Constructor.

Definition at line 14 of file f4arr3.cpp.

dvar4_array::~dvar4_array

(

)

Destructor.

Definition at line 91 of file f4arr.cpp.

Member Function Documentation

void dvar4_array::allocate	(	int	hsl,
		int	hsu,
		int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

hsl	lower i4_array index
hsu	upper i4_array index
sl	lower i3_array index
su	upper i3_array index
nrl	lower matrix row index
nrh	upper matrix row index
ncl	lower matrix column index
nch	upper matrix column index

Definition at line 309 of file f4arr.cpp.

Referenced by dvar5_array::allocate(), exp(), log(), mfexp(), operator/(), and sqrt().

void dvar4_array::allocate	(	int	hsl,
		int	hsu,
		int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		const ivector &	ncl,
		const ivector &	nch
	)

Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

hsl	lower i4_array index
hsu	upper i4_array index
sl	lower i3_array index
su	upper i3_array index
nrl	lower matrix row index
nrh	upper matrix row index
ncl	vector of lower matrix column indexes
nch	vector upper matrix column indexes

Definition at line 349 of file f4arr.cpp.

void dvar4_array::allocate	(	int	hsl,
		int	hsu,
		int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		const ivector &	ncl,
		const ivector &	nch
	)

Allocate array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

hsl	lower i4_array index
hsu	upper i4_array index
sl	lower i3_array index
su	upper i3_array index
nrl	vector of lower matrix row indexes
nrh	vector of upper matrix row indexes
ncl	vector of lower matrix column indexes
nch	vector of upper matrix column indexes

Definition at line 525 of file f4arr.cpp.

void dvar4_array::allocate	(	ad_integer	hsl,
		ad_integer	hsu,
		const index_type &	sl,
		const index_type &	sh,
		const index_type &	nrl,
		const index_type &	nrh,
		const index_type &	ncl,
		const index_type &	nch
	)

Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

hsl	lower i4_array index
hsu	upper i4_array index
sl	lower i3_array index
su	upper i3_array index
nrl	lower matrix row index
nrh	upper matrix row index
ncl	lower matrix column index
nch	upper matrix column index

Definition at line 390 of file f4arr.cpp.

void dvar4_array::allocate	(	ad_integer	hsl,
		ad_integer	hsu,
		const index_type &	sl,
		const index_type &	sh,
		const index_type &	nrl,
		const index_type &	nrh
	)

Description not yet available.

Parameters

Definition at line 423 of file f4arr.cpp.

void dvar4_array::allocate	(	ad_integer	hsl,
		ad_integer	hsu,
		const index_type &	sl,
		const index_type &	sh
	)

Description not yet available.

Parameters

Definition at line 455 of file f4arr.cpp.

void dvar4_array::allocate	(	ad_integer	hsl,
		ad_integer	hsu
	)

Allocate vector of empty dvar3_array with dimension [hsl to hsu].

Parameters

hsl	lower vector index
hsu	upper vector index

Definition at line 487 of file f4arr.cpp.

void dvar4_array::allocate

(

void

)

Initializes to NULL.

Definition at line 20 of file f4arr3.cpp.

Referenced by named_dvar4_array::allocate(), deallocate(), dvar4_array(), and shallow_copy().

void dvar4_array::allocate

(

const d4_array &

m1

)

Allocate dvar4_array with same dimensions as m1.

Definition at line 667 of file f4arr.cpp.

void dvar4_array::allocate

(

const dvar4_array &

m1

)

Allocate dvar4_array with same dimensions as m1.

Definition at line 697 of file f4arr.cpp.

void dvar4_array::allocate	(	int	hsl,
		int	hsu,
		int	sl,
		const ivector &	sh,
		int	nrl,
		const imatrix &	nrh,
		int	ncl,
		int	nch
	)

Definition at line 613 of file f4arr.cpp.

int dvar4_array::colmax ( void  )

inline

Definition at line 5591 of file fvar.hpp.

Referenced by colsize().

int dvar4_array::colmax ( void  ) const

inline

Definition at line 5646 of file fvar.hpp.

int dvar4_array::colmin ( void  )

inline

Definition at line 5587 of file fvar.hpp.

Referenced by colsize().

int dvar4_array::colmin ( void  ) const

inline

Definition at line 5642 of file fvar.hpp.

int dvar4_array::colsize ( )

inline

Definition at line 5616 of file fvar.hpp.

int dvar4_array::colsize ( ) const

inline

Definition at line 5676 of file fvar.hpp.

void dvar4_array::deallocate

(

void

)

Deallocate dvar4_array memory.

Definition at line 66 of file f4arr.cpp.

Referenced by ~dvar4_array().

dvar3_array& dvar4_array::elem ( int  i )

inline

Definition at line 5479 of file fvar.hpp.

dvar_matrix& dvar4_array::elem ( int  i, int  j  )

inline

Definition at line 5483 of file fvar.hpp.

dvar_vector& dvar4_array::elem ( int  i, int  j, int  k  )

inline

Definition at line 5487 of file fvar.hpp.

prevariable dvar4_array::elem ( int  i, int  j, int  k, int  l  )

inline

Definition at line 5491 of file fvar.hpp.

const dvar3_array& dvar4_array::elem ( int  i ) const

inline

Definition at line 5495 of file fvar.hpp.

const dvar_matrix& dvar4_array::elem ( int  i, int  j  ) const

inline

Definition at line 5499 of file fvar.hpp.

const dvar_vector& dvar4_array::elem ( int  i, int  j, int  k  ) const

inline

Definition at line 5503 of file fvar.hpp.

const prevariable dvar4_array::elem ( int  i, int  j, int  k, int  l  ) const

inline

Definition at line 5507 of file fvar.hpp.

unsigned int dvar4_array::get_ncopies ( void  ) const

inline

Definition at line 5684 of file fvar.hpp.

int dvar4_array::hslicemax ( ) const

inline

Definition at line 5624 of file fvar.hpp.

Referenced by allocate(), dvar4_array(), hslicesize(), indexmax(), initialize(), operator<<(), operator=(), and operator>>().

int dvar4_array::hslicemin ( ) const

inline

Definition at line 5623 of file fvar.hpp.

Referenced by allocate(), colmax(), colmin(), dvar4_array(), hslicesize(), indexmin(), initialize(), operator<<(), operator=(), operator>>(), rowmax(), rowmin(), slicemax(), and slicemin().

unsigned int dvar4_array::hslicesize ( ) const

inline

Definition at line 5660 of file fvar.hpp.

Referenced by allocate().

int dvar4_array::indexmax ( void  ) const

inline

Definition at line 5622 of file fvar.hpp.

Referenced by colmax(), log(), operator/(), operator/=(), size_count(), sub_unallocated(), and sum().

int dvar4_array::indexmin ( void  ) const

inline

Definition at line 5621 of file fvar.hpp.

Referenced by colmin(), deallocate(), log(), operator/(), operator/=(), size_count(), sub_unallocated(), and sum().

void dvar4_array::initialize

(

void

)

Description not yet available.

Parameters

Definition at line 586 of file f4arr.cpp.

Referenced by dvar5_array::initialize().

int dvar4_array::operator! ( void  ) const

inline

Definition at line 5458 of file fvar.hpp.

dvar3_array& dvar4_array::operator() ( int  i )

inline

Definition at line 5516 of file fvar.hpp.

dvar_matrix& dvar4_array::operator() ( int  i, int  j  )

inline

Definition at line 5524 of file fvar.hpp.

dvar_vector& dvar4_array::operator() ( int  i, int  j, int  k  )

inline

Definition at line 5528 of file fvar.hpp.

prevariable dvar4_array::operator() ( int  i, int  j, int  k, int  l  )

inline

Definition at line 5532 of file fvar.hpp.

const dvar3_array& dvar4_array::operator() ( int  i ) const

inline

Definition at line 5536 of file fvar.hpp.

const dvar_matrix& dvar4_array::operator() ( int  i, int  j  ) const

inline

Definition at line 5544 of file fvar.hpp.

const dvar_vector& dvar4_array::operator() ( int  i, int  j, int  k  ) const

inline

Definition at line 5548 of file fvar.hpp.

const prevariable dvar4_array::operator() ( int  i, int  j, int  k, int  l  ) const

inline

Definition at line 5552 of file fvar.hpp.

void dvar4_array::operator/=

(

const prevariable &

d

)

Description not yet available.

Parameters

Definition at line 98 of file f4arr2.cpp.

void dvar4_array::operator/=

(

const double &

d

)

Description not yet available.

Parameters

Definition at line 118 of file f4arr2.cpp.

dvar4_array & dvar4_array::operator=

(

const d4_array &

m

)

Description not yet available.

Parameters

Definition at line 248 of file f4arr.cpp.

Referenced by named_dvar4_array::operator=().

dvar4_array & dvar4_array::operator=

(

const dvar4_array &

m

)

Description not yet available.

Parameters

Definition at line 274 of file f4arr.cpp.

dvar3_array& dvar4_array::operator[] ( int  i )

inline

Definition at line 5520 of file fvar.hpp.

const dvar3_array& dvar4_array::operator[] ( int  i ) const

inline

Definition at line 5540 of file fvar.hpp.

int dvar4_array::rowmax ( void  )

inline

Definition at line 5583 of file fvar.hpp.

Referenced by colmax(), colmin(), rowmax(), and rowsize().

int dvar4_array::rowmax ( void  ) const

inline

Definition at line 5638 of file fvar.hpp.

int dvar4_array::rowmin ( void  )

inline

Definition at line 5579 of file fvar.hpp.

Referenced by rowmin(), and rowsize().

int dvar4_array::rowmin ( void  ) const

inline

Definition at line 5634 of file fvar.hpp.

int dvar4_array::rowsize ( void  )

inline

Definition at line 5611 of file fvar.hpp.

int dvar4_array::rowsize ( void  ) const

inline

Definition at line 5671 of file fvar.hpp.

void dvar4_array::shallow_copy

(

const dvar4_array &

other

)

Shallow copy other data structure pointers.

Parameters

other

dvar4_array

Definition at line 28 of file f4arr.cpp.

Referenced by dvar4_array(), sub(), and dvar5_array::sub().

int dvar4_array::slicemax ( void  )

inline

Definition at line 5575 of file fvar.hpp.

Referenced by exp(), mfexp(), slicemax(), slicesize(), and sqrt().

int dvar4_array::slicemax ( void  ) const

inline

Definition at line 5630 of file fvar.hpp.

int dvar4_array::slicemin ( void  )

inline

Definition at line 5571 of file fvar.hpp.

Referenced by colmax(), colmin(), exp(), mfexp(), rowmax(), rowmin(), slicemin(), slicesize(), and sqrt().

int dvar4_array::slicemin ( void  ) const

inline

Definition at line 5626 of file fvar.hpp.

int dvar4_array::slicesize ( )

inline

Definition at line 5606 of file fvar.hpp.

int dvar4_array::slicesize ( ) const

inline

Definition at line 5666 of file fvar.hpp.

dvar4_array dvar4_array::sub	(	int	nrl,
		int	nrh
	)

Description not yet available.

Parameters

Definition at line 49 of file f4arr.cpp.

d4_array dvar4_array::vale

(

d4_array &

)

Friends And Related Function Documentation

friend class four_array_shape

friend

Definition at line 5569 of file fvar.hpp.

Referenced by allocate().

Member Data Documentation

four_array_shape* dvar4_array::shape

private

Definition at line 5435 of file fvar.hpp.

Referenced by allocate(), deallocate(), get_ncopies(), hslicemax(), hslicemin(), operator!(), and shallow_copy().

dvar3_array* dvar4_array::t

private

Definition at line 5436 of file fvar.hpp.

Referenced by allocate(), deallocate(), dvar4_array(), elem(), initialize(), operator()(), operator/=(), operator=(), operator[](), and shallow_copy().

---

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

• fvar.hpp (Last Changed on August 07, 2022 for git-revision 0a920593f1602d0b526036677a330e80065904b7.)
• f4arr.cpp (Last Changed on July 18, 2022 for git-revision ecde26fdbf8eed734a006d8e80bd4f4ec5d5458f.)
• f4arr2.cpp (Last Changed on August 06, 2022 for git-revision 808780089317c67198079de06b64df009a4a6543.)
• f4arr3.cpp (Last Changed on June 27, 2022 for git-revision 27f74515bdfe62cb5507e9c069be4ccdd6bf0208.)