ObjexxFCL::FArray5D< T > Class Template Reference

FArray5D: Fortran-Compatible 5D Array. More...

#include <FArray5D.hh>

Inheritance diagram for ObjexxFCL::FArray5D< T >:

Collaboration diagram for ObjexxFCL::FArray5D< T >:

List of all members.

Public Types
typedef Super::Base	Base
typedef Base::Section	Section
typedef Super::IR	SIR
typedef DynamicIndexRange	IR
typedef Base::value_type	value_type
typedef Base::reference	reference
typedef Base::const_reference	const_reference
typedef Base::pointer	pointer
typedef Base::const_pointer	const_pointer
typedef Base::size_type	size_type
typedef Base::difference_type	difference_type
typedef Base::Value	Value
typedef Base::Reference	Reference
typedef Base::ConstReference	ConstReference
typedef Base::Pointer	Pointer
typedef Base::ConstPointer	ConstPointer
typedef Base::Size	Size
typedef Base::Difference	Difference
typedef FArrayInitializer< T, ObjexxFCL::FArray5D >	Initializer
typedef Initializer::function_type	InitializerFunction
Public Member Functions
	FArray5D ()
	Default Constructor.
	FArray5D (FArray5D const &a)
	Copy Constructor.
template<typename U >
	FArray5D (FArray5D< U > const &a)
	Copy Constructor Template.
template<typename U >
	FArray5D (FArray5< U > const &a)
	Super Constructor Template.
	FArray5D (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a)
	IndexRange Constructor.
	FArray5D (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a, T const &t)
	IndexRange + Initializer Value Constructor.
	FArray5D (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a, InitializerFunction const &function_a)
	IndexRange + Initializer Function Constructor.
template<typename U >
	FArray5D (FArray5< U > const &a, IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a)
	Super + IndexRange Constructor Template.
template<typename U >
	FArray5D (FArray5< U > const &a, IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a, T const &t)
	Super + IndexRange + Fill Value Constructor Template.
virtual	~FArray5D ()
	Destructor.
FArray5D &	operator= (FArray5D const &a)
	Copy Assignment.
FArray5D &	operator= (Super const &a)
	Super Assignment.
template<typename U >
FArray5D &	operator= (FArray5< U > const &a)
	Super Assignment Template.
template<typename U >
FArray5D &	operator+= (FArray5< U > const &a)
	+= Array Template
template<typename U >
FArray5D &	operator-= (FArray5< U > const &a)
	-= Array Template
FArray5D &	operator= (T const &t)
	= Value
FArray5D &	operator+= (T const &t)
	+= Value
FArray5D &	operator-= (T const &t)
	-= Value
FArray5D &	operator*= (T const &t)
	*= Value
FArray5D &	operator/= (T const &t)
	/= Value
T const &	operator() (int const i1, int const i2, int const i3, int const i4, int const i5) const
	array( i1, i2, i3, i4, i5 ) const
T &	operator() (int const i1, int const i2, int const i3, int const i4, int const i5)
	array( i1, i2, i3, i4, i5 )
Section const	a (int const i1, int const i2, int const i3, int const i4, int const i5) const
	Section Starting at array( i1, i2, i3, i4, i5 )
size_type	index (int const i1, int const i2, int const i3, int const i4, int const i5) const
	Linear Index.
T const &	operator[] (size_type const i) const
	array[ i ] const: Linear Subscript
T &	operator[] (size_type const i)
	array[ i ]: Linear Subscript
bool	dimensions_initialized () const
	Dimensions Initialized?
bool	contains (int const i1, int const i2, int const i3, int const i4, int const i5) const
	Contains Indexed Element?
bool	initializer_active () const
	Initializer Active?
IR const &	I1 () const
	IndexRange of Dimension 1.
int	l1 () const
	Lower Index of Dimension 1.
int	u1 () const
	Upper Index of Dimension 1.
IR const &	I2 () const
	IndexRange of Dimension 2.
int	l2 () const
	Lower Index of Dimension 2.
int	u2 () const
	Upper Index of Dimension 2.
IR const &	I3 () const
	IndexRange of Dimension 3.
int	l3 () const
	Lower Index of Dimension 3.
int	u3 () const
	Upper Index of Dimension 3.
IR const &	I4 () const
	IndexRange of Dimension 4.
int	l4 () const
	Lower Index of Dimension 4.
int	u4 () const
	Upper Index of Dimension 4.
IR const &	I5 () const
	IndexRange of Dimension 5.
int	l5 () const
	Lower Index of Dimension 5.
int	u5 () const
	Upper Index of Dimension 5.
size_type	size5 () const
	Size of Dimension 5.
FArray5D &	clear ()
	Clear.
FArray5D &	dimension (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a)
	Dimension by IndexRanges.
FArray5D &	dimension (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a, T const &t)
	Dimension by IndexRanges + Initializer Value.
FArray5D &	dimension (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a, InitializerFunction const &function_a)
	Dimension by IndexRanges + Initializer Function.
template<typename U >
FArray5D &	dimension (FArray5< U > const &a)
	Dimension by Array Template.
template<typename U >
FArray5D &	dimension (FArray5< U > const &a, T const &t)
	Dimension by Array + Initializer Value Template.
template<typename U >
FArray5D &	dimension (FArray5< U > const &a, InitializerFunction const &function_a)
	Dimension by Array + Initializer Function Template.
FArray5D &	redimension (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a)
	Data-Preserving Redimension by IndexRanges.
FArray5D &	redimension (IR const &I1_a, IR const &I2_a, IR const &I3_a, IR const &I4_a, IR const &I5_a, T const &t)
	Data-Preserving Redimension by IndexRanges + Fill Value.
template<typename U >
FArray5D &	redimension (FArray5< U > const &a)
	Data-Preserving Redimension by Array Template.
template<typename U >
FArray5D &	redimension (FArray5< U > const &a, T const &t)
	Data-Preserving Redimension by Array + Fill Value Template.
FArray5D &	initializer (T const &t)
	Set Initializer Value.
FArray5D &	initializer (InitializerFunction const &function_a)
	Set Initializer Function.
FArray5D &	initializer_clear ()
	Clear Initializer.
FArray5D &	initialize ()
	Initialize.
FArray5D &	swap (FArray5D &v)
	Swap.
void	update ()
	Update.
void	destructed (Subject const &)
	Update for Destruction of a Subject.
Protected Member Functions
void	dimension_assign (SIR const &I1_a, SIR const &I2_a, SIR const &I3_a, SIR const &I4_a, SIR const &I5_a)
	Dimension by IndexRanges.
Friends
class	FArray5D
class	FArray5P< T >
class	FArray5A< T >
void	swap (FArray5D &a, FArray5D &b)
	Swap.
FArray5D	operator- (Super const &a)
	-Array
FArray5D	operator+ (Super const &a, Super const &b)
	Array + Array.
FArray5D	operator- (Super const &a, Super const &b)
	Array - Array.
FArray5D	operator+ (Super const &a, T const &t)
	Array + Value.
FArray5D	operator+ (T const &t, Super const &a)
	Value + Array.
FArray5D	operator- (Super const &a, T const &t)
	Array - Value.
FArray5D	operator- (T const &t, Super const &a)
	Value - Array.
FArray5D	operator* (Super const &a, T const &t)
	Array * Value.
FArray5D	operator* (T const &t, Super const &a)
	Value * Array.
FArray5D	operator/ (Super const &a, T const &t)
	Array / Value.

---

Detailed Description

template<typename T>
class ObjexxFCL::FArray5D< T >

FArray5D: Fortran-Compatible 5D Array.

---

Member Typedef Documentation

template<typename T>

typedef Super::Base ObjexxFCL::FArray5D< T >::Base

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::const_pointer ObjexxFCL::FArray5D< T >::const_pointer

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::const_reference ObjexxFCL::FArray5D< T >::const_reference

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::ConstPointer ObjexxFCL::FArray5D< T >::ConstPointer

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::ConstReference ObjexxFCL::FArray5D< T >::ConstReference

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::Difference ObjexxFCL::FArray5D< T >::Difference

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::difference_type ObjexxFCL::FArray5D< T >::difference_type

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef FArrayInitializer< T, ObjexxFCL::FArray5D > ObjexxFCL::FArray5D< T >::Initializer

template<typename T>

typedef Initializer::function_type ObjexxFCL::FArray5D< T >::InitializerFunction

template<typename T>

typedef DynamicIndexRange ObjexxFCL::FArray5D< T >::IR

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::pointer ObjexxFCL::FArray5D< T >::pointer

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::Pointer ObjexxFCL::FArray5D< T >::Pointer

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::Reference ObjexxFCL::FArray5D< T >::Reference

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::reference ObjexxFCL::FArray5D< T >::reference

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::Section ObjexxFCL::FArray5D< T >::Section

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Super::IR ObjexxFCL::FArray5D< T >::SIR

template<typename T>

typedef Base::Size ObjexxFCL::FArray5D< T >::Size

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::size_type ObjexxFCL::FArray5D< T >::size_type

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::Value ObjexxFCL::FArray5D< T >::Value

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

typedef Base::value_type ObjexxFCL::FArray5D< T >::value_type

Reimplemented from ObjexxFCL::FArray5< T >.

---

Constructor & Destructor Documentation

template<typename T>

ObjexxFCL::FArray5D< T >::FArray5D

(

)

[inline]

Default Constructor.

Referenced by ObjexxFCL::FArray5D< T >::redimension().

template<typename T>

ObjexxFCL::FArray5D< T >::FArray5D

(

FArray5D< T > const &

a

)

[inline]

Copy Constructor.

template<typename T>

template<typename U >

ObjexxFCL::FArray5D< T >::FArray5D

(

FArray5D< U > const &

a

)

[inline, explicit]

Copy Constructor Template.

template<typename T>

template<typename U >

ObjexxFCL::FArray5D< T >::FArray5D

(

FArray5< U > const &

a

)

[inline, explicit]

Super Constructor Template.

template<typename T>

ObjexxFCL::FArray5D< T >::FArray5D	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a
	)		[inline]

IndexRange Constructor.

template<typename T>

ObjexxFCL::FArray5D< T >::FArray5D	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a,
		T const &	t
	)		[inline]

IndexRange + Initializer Value Constructor.

References ObjexxFCL::FArray5D< T >::initialize().

template<typename T>

ObjexxFCL::FArray5D< T >::FArray5D	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a,
		InitializerFunction const &	function_a
	)		[inline]

IndexRange + Initializer Function Constructor.

References ObjexxFCL::FArray5D< T >::initialize().

template<typename T>

template<typename U >

ObjexxFCL::FArray5D< T >::FArray5D	(	FArray5< U > const &	a,
		IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a
	)		[inline]

Super + IndexRange Constructor Template.

References ObjexxFCL::FArray5D< T >::a(), ObjexxFCL::FArray< T >::dimensions_initialized(), ObjexxFCL::FArray5D< T >::dimensions_initialized(), ObjexxFCL::DynamicIndexRange::l(), ObjexxFCL::FArray5< T >::l1(), ObjexxFCL::FArray5< T >::l2(), ObjexxFCL::FArray5< T >::l3(), ObjexxFCL::FArray5< T >::l4(), ObjexxFCL::FArray5< T >::l5(), numeric::max(), basic::options::OptionKeys::ddg::min, ObjexxFCL::FArray5D< T >::operator()(), basic::T(), ObjexxFCL::DynamicIndexRange::u(), ObjexxFCL::FArray5< T >::u1(), ObjexxFCL::FArray5< T >::u2(), ObjexxFCL::FArray5< T >::u3(), ObjexxFCL::FArray5< T >::u4(), and ObjexxFCL::FArray5< T >::u5().

template<typename T>

template<typename U >

ObjexxFCL::FArray5D< T >::FArray5D	(	FArray5< U > const &	a,
		IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a,
		T const &	t
	)		[inline]

Super + IndexRange + Fill Value Constructor Template.

References ObjexxFCL::FArray5D< T >::a(), ObjexxFCL::FArray< T >::dimensions_initialized(), ObjexxFCL::FArray5D< T >::dimensions_initialized(), ObjexxFCL::DynamicIndexRange::l(), ObjexxFCL::FArray5< T >::l1(), ObjexxFCL::FArray5< T >::l2(), ObjexxFCL::FArray5< T >::l3(), ObjexxFCL::FArray5< T >::l4(), ObjexxFCL::FArray5< T >::l5(), numeric::max(), basic::options::OptionKeys::ddg::min, ObjexxFCL::FArray5D< T >::operator()(), basic::T(), sd::t, ObjexxFCL::DynamicIndexRange::u(), ObjexxFCL::FArray5< T >::u1(), ObjexxFCL::FArray5< T >::u2(), ObjexxFCL::FArray5< T >::u3(), ObjexxFCL::FArray5< T >::u4(), and ObjexxFCL::FArray5< T >::u5().

template<typename T>

virtual ObjexxFCL::FArray5D< T >::~FArray5D

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

template<typename T>

Section const ObjexxFCL::FArray5D< T >::a	(	int const	i1,
		int const	i2,
		int const	i3,
		int const	i4,
		int const	i5
	)		const [inline]

Section Starting at array( i1, i2, i3, i4, i5 )

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray< T >::array_, ObjexxFCL::FArray< T >::array_size_, ObjexxFCL::DynamicIndexRange::contains(), ObjexxFCL::FArray5< T >::s1_, ObjexxFCL::FArray5< T >::s2_, ObjexxFCL::FArray5< T >::s3_, ObjexxFCL::FArray5< T >::s4_, and ObjexxFCL::FArray< T >::shift_.

Referenced by ObjexxFCL::FArray5D< T >::FArray5D().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::clear

(

)

[inline, virtual]

Clear.

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArrayInitializer< T, Array >::clear(), ObjexxFCL::FArray5< T >::clear(), ObjexxFCL::DynamicIndexRange::clear_no_notify(), and ObjexxFCL::Observer::notify().

template<typename T>

bool ObjexxFCL::FArray5D< T >::contains	(	int const	i1,
		int const	i2,
		int const	i3,
		int const	i4,
		int const	i5
	)		const [inline, virtual]

Contains Indexed Element?

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::contains().

template<typename T>

void ObjexxFCL::FArray5D< T >::destructed

(

Subject const &

)

[inline, virtual]

Update for Destruction of a Subject.

Implements ObjexxFCL::Observer.

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::dimension	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a
	)		[inline]

Dimension by IndexRanges.

References ObjexxFCL::DynamicIndexRange::assign_no_notify(), ObjexxFCL::FArrayInitializer< T, Array >::clear(), and ObjexxFCL::Observer::notify().

Referenced by ObjexxFCL::FArray5D< T >::operator=().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::dimension	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a,
		T const &	t
	)		[inline]

Dimension by IndexRanges + Initializer Value.

References ObjexxFCL::DynamicIndexRange::assign_no_notify(), ObjexxFCL::FArray5D< T >::initialize(), ObjexxFCL::Observer::notify(), and sd::t.

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::dimension	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a,
		InitializerFunction const &	function_a
	)		[inline]

Dimension by IndexRanges + Initializer Function.

References ObjexxFCL::DynamicIndexRange::assign_no_notify(), ObjexxFCL::FArray5D< T >::initialize(), and ObjexxFCL::Observer::notify().

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::dimension

(

FArray5< U > const &

a

)

[inline]

Dimension by Array Template.

References ObjexxFCL::DynamicIndexRange::assign_no_notify(), ObjexxFCL::FArrayInitializer< T, Array >::clear(), ObjexxFCL::FArray5< T >::I1(), ObjexxFCL::FArray5< T >::I2(), ObjexxFCL::FArray5< T >::I3(), ObjexxFCL::FArray5< T >::I4(), ObjexxFCL::FArray5< T >::I5(), and ObjexxFCL::Observer::notify().

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::dimension	(	FArray5< U > const &	a,
		T const &	t
	)		[inline]

Dimension by Array + Initializer Value Template.

References ObjexxFCL::DynamicIndexRange::assign_no_notify(), ObjexxFCL::FArray5< T >::I1(), ObjexxFCL::FArray5< T >::I2(), ObjexxFCL::FArray5< T >::I3(), ObjexxFCL::FArray5< T >::I4(), ObjexxFCL::FArray5< T >::I5(), ObjexxFCL::FArray5D< T >::initialize(), ObjexxFCL::Observer::notify(), and sd::t.

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::dimension	(	FArray5< U > const &	a,
		InitializerFunction const &	function_a
	)		[inline]

Dimension by Array + Initializer Function Template.

References ObjexxFCL::DynamicIndexRange::assign_no_notify(), ObjexxFCL::FArray5< T >::I1(), ObjexxFCL::FArray5< T >::I2(), ObjexxFCL::FArray5< T >::I3(), ObjexxFCL::FArray5< T >::I4(), ObjexxFCL::FArray5< T >::I5(), ObjexxFCL::FArray5D< T >::initialize(), and ObjexxFCL::Observer::notify().

template<typename T>

void ObjexxFCL::FArray5D< T >::dimension_assign	(	SIR const &	I1_a,
		SIR const &	I2_a,
		SIR const &	I3_a,
		SIR const &	I4_a,
		SIR const &	I5_a
	)		[inline, protected, virtual]

Dimension by IndexRanges.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::assign_no_notify(), ObjexxFCL::FArrayInitializer< T, Array >::clear(), and ObjexxFCL::Observer::notify().

template<typename T>

bool ObjexxFCL::FArray5D< T >::dimensions_initialized

(

)

const [inline, virtual]

Dimensions Initialized?

Implements ObjexxFCL::FArray< T >.

References ObjexxFCL::DynamicIndexRange::initialized().

Referenced by ObjexxFCL::FArray5D< T >::FArray5D(), and ObjexxFCL::FArray5D< T >::initialize().

template<typename T>

IR const& ObjexxFCL::FArray5D< T >::I1

(

)

const [inline, virtual]

IndexRange of Dimension 1.

Implements ObjexxFCL::FArray5< T >.

template<typename T>

IR const& ObjexxFCL::FArray5D< T >::I2

(

)

const [inline, virtual]

IndexRange of Dimension 2.

Implements ObjexxFCL::FArray5< T >.

template<typename T>

IR const& ObjexxFCL::FArray5D< T >::I3

(

)

const [inline, virtual]

IndexRange of Dimension 3.

Implements ObjexxFCL::FArray5< T >.

template<typename T>

IR const& ObjexxFCL::FArray5D< T >::I4

(

)

const [inline, virtual]

IndexRange of Dimension 4.

Implements ObjexxFCL::FArray5< T >.

template<typename T>

IR const& ObjexxFCL::FArray5D< T >::I5

(

)

const [inline, virtual]

IndexRange of Dimension 5.

Implements ObjexxFCL::FArray5< T >.

template<typename T>

size_type ObjexxFCL::FArray5D< T >::index	(	int const	i1,
		int const	i2,
		int const	i3,
		int const	i4,
		int const	i5
	)		const [inline]

Linear Index.

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::initialized(), ObjexxFCL::FArray5< T >::s1_, ObjexxFCL::FArray5< T >::s2_, ObjexxFCL::FArray5< T >::s3_, ObjexxFCL::FArray5< T >::s4_, and ObjexxFCL::FArray< T >::shift_.

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::initialize

(

)

[inline]

Initialize.

References ObjexxFCL::FArray5D< T >::dimensions_initialized(), ObjexxFCL::FArrayInitializer< T, Array >::function(), ObjexxFCL::FArrayInitializer< T, Array >::is_active(), ObjexxFCL::FArrayInitializer< T, Array >::is_function(), ObjexxFCL::FArrayInitializer< T, Array >::is_value(), and ObjexxFCL::FArrayInitializer< T, Array >::value().

Referenced by ObjexxFCL::FArray5D< T >::dimension(), ObjexxFCL::FArray5D< T >::FArray5D(), and ObjexxFCL::FArray5D< T >::update().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::initializer

(

T const &

t

)

[inline]

Set Initializer Value.

References sd::t.

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::initializer

(

InitializerFunction const &

function_a

)

[inline]

Set Initializer Function.

template<typename T>

bool ObjexxFCL::FArray5D< T >::initializer_active

(

)

const [inline, virtual]

Initializer Active?

Implements ObjexxFCL::FArray< T >.

References ObjexxFCL::FArrayInitializer< T, Array >::is_active().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::initializer_clear

(

)

[inline]

Clear Initializer.

References ObjexxFCL::FArrayInitializer< T, Array >::clear().

template<typename T>

int ObjexxFCL::FArray5D< T >::l1

(

)

const [inline, virtual]

Lower Index of Dimension 1.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::l().

template<typename T>

int ObjexxFCL::FArray5D< T >::l2

(

)

const [inline, virtual]

Lower Index of Dimension 2.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::l().

template<typename T>

int ObjexxFCL::FArray5D< T >::l3

(

)

const [inline, virtual]

Lower Index of Dimension 3.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::l().

template<typename T>

int ObjexxFCL::FArray5D< T >::l4

(

)

const [inline, virtual]

Lower Index of Dimension 4.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::l().

template<typename T>

int ObjexxFCL::FArray5D< T >::l5

(

)

const [inline, virtual]

Lower Index of Dimension 5.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::l().

template<typename T>

T& ObjexxFCL::FArray5D< T >::operator()	(	int const	i1,
		int const	i2,
		int const	i3,
		int const	i4,
		int const	i5
	)		[inline]

array( i1, i2, i3, i4, i5 )

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::contains(), ObjexxFCL::FArray5< T >::s1_, ObjexxFCL::FArray5< T >::s2_, ObjexxFCL::FArray5< T >::s3_, ObjexxFCL::FArray5< T >::s4_, and ObjexxFCL::FArray< T >::sarray_.

template<typename T>

T const& ObjexxFCL::FArray5D< T >::operator()	(	int const	i1,
		int const	i2,
		int const	i3,
		int const	i4,
		int const	i5
	)		const [inline]

array( i1, i2, i3, i4, i5 ) const

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::contains(), ObjexxFCL::FArray5< T >::s1_, ObjexxFCL::FArray5< T >::s2_, ObjexxFCL::FArray5< T >::s3_, ObjexxFCL::FArray5< T >::s4_, and ObjexxFCL::FArray< T >::sarray_.

Referenced by ObjexxFCL::FArray5D< T >::FArray5D().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::operator*=

(

T const &

t

)

[inline]

*= Value

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5< T >::operator*=().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::operator+=

(

T const &

t

)

[inline]

+= Value

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5< T >::operator+=().

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::operator+=

(

FArray5< U > const &

a

)

[inline]

+= Array Template

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5< T >::operator+=().

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::operator-=

(

FArray5< U > const &

a

)

[inline]

-= Array Template

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5< T >::operator-=().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::operator-=

(

T const &

t

)

[inline]

-= Value

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5< T >::operator-=().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::operator/=

(

T const &

t

)

[inline]

/= Value

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5< T >::operator/=().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::operator=

(

Super const &

a

)

[inline]

Super Assignment.

References ObjexxFCL::FArray5D< T >::dimension(), ObjexxFCL::FArray5< T >::equal_dimension(), and ObjexxFCL::FArray< T >::operator=().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::operator=

(

FArray5D< T > const &

a

)

[inline]

Copy Assignment.

References ObjexxFCL::FArray5D< T >::dimension(), ObjexxFCL::FArray5< T >::equal_dimension(), and ObjexxFCL::FArray< T >::operator=().

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::operator=

(

FArray5< U > const &

a

)

[inline]

Super Assignment Template.

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5D< T >::dimension(), ObjexxFCL::FArray5< T >::equal_dimension(), and ObjexxFCL::FArray< T >::operator=().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::operator=

(

T const &

t

)

[inline]

= Value

Reimplemented from ObjexxFCL::FArray5< T >.

References ObjexxFCL::FArray5< T >::operator=().

template<typename T>

T& ObjexxFCL::FArray5D< T >::operator[]

(

size_type const

i

)

[inline]

array[ i ]: Linear Subscript

Reimplemented from ObjexxFCL::FArray< T >.

References ObjexxFCL::FArray< T >::array_, color_pdb::i, and ObjexxFCL::FArray< T >::size_.

template<typename T>

T const& ObjexxFCL::FArray5D< T >::operator[]

(

size_type const

i

)

const [inline]

array[ i ] const: Linear Subscript

Reimplemented from ObjexxFCL::FArray< T >.

References ObjexxFCL::FArray< T >::array_, color_pdb::i, and ObjexxFCL::FArray< T >::size_.

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::redimension	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a,
		T const &	t
	)		[inline]

Data-Preserving Redimension by IndexRanges + Fill Value.

References ObjexxFCL::FArray5D< T >::FArray5D().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::redimension	(	IR const &	I1_a,
		IR const &	I2_a,
		IR const &	I3_a,
		IR const &	I4_a,
		IR const &	I5_a
	)		[inline]

Data-Preserving Redimension by IndexRanges.

References ObjexxFCL::FArray5D< T >::FArray5D().

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::redimension	(	FArray5< U > const &	a,
		T const &	t
	)		[inline]

Data-Preserving Redimension by Array + Fill Value Template.

References ObjexxFCL::FArray5D< T >::FArray5D(), ObjexxFCL::FArray5< T >::I1(), ObjexxFCL::FArray5< T >::I2(), ObjexxFCL::FArray5< T >::I3(), ObjexxFCL::FArray5< T >::I4(), ObjexxFCL::FArray5< T >::I5(), ObjexxFCL::FArray5D< T >::swap(), and sd::t.

template<typename T>

template<typename U >

FArray5D& ObjexxFCL::FArray5D< T >::redimension

(

FArray5< U > const &

a

)

[inline]

Data-Preserving Redimension by Array Template.

References ObjexxFCL::FArray5D< T >::FArray5D(), ObjexxFCL::FArray5< T >::I1(), ObjexxFCL::FArray5< T >::I2(), ObjexxFCL::FArray5< T >::I3(), ObjexxFCL::FArray5< T >::I4(), ObjexxFCL::FArray5< T >::I5(), and ObjexxFCL::FArray5D< T >::swap().

template<typename T>

size_type ObjexxFCL::FArray5D< T >::size5

(

)

const [inline, virtual]

Size of Dimension 5.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::IndexRange::size().

template<typename T>

FArray5D& ObjexxFCL::FArray5D< T >::swap

(

FArray5D< T > &

v

)

[inline]

Swap.

References ObjexxFCL::Observer::notify(), ObjexxFCL::FArray5< T >::swap5DB(), and ObjexxFCL::DynamicIndexRange::swap_no_notify().

Referenced by ObjexxFCL::FArray5D< T >::redimension(), std::swap(), and ObjexxFCL::swap().

template<typename T>

int ObjexxFCL::FArray5D< T >::u1

(

)

const [inline, virtual]

Upper Index of Dimension 1.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::u().

template<typename T>

int ObjexxFCL::FArray5D< T >::u2

(

)

const [inline, virtual]

Upper Index of Dimension 2.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::u().

template<typename T>

int ObjexxFCL::FArray5D< T >::u3

(

)

const [inline, virtual]

Upper Index of Dimension 3.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::u().

template<typename T>

int ObjexxFCL::FArray5D< T >::u4

(

)

const [inline, virtual]

Upper Index of Dimension 4.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::u().

template<typename T>

int ObjexxFCL::FArray5D< T >::u5

(

)

const [inline, virtual]

Upper Index of Dimension 5.

Implements ObjexxFCL::FArray5< T >.

References ObjexxFCL::DynamicIndexRange::u().

template<typename T>

void ObjexxFCL::FArray5D< T >::update

(

)

[inline, virtual]

Update.

Implements ObjexxFCL::Observer.

References ObjexxFCL::FArray5D< T >::initialize().

---

Friends And Related Function Documentation

template<typename T>

friend class FArray5A< T > [friend]

template<typename T>

friend class FArray5D [friend]

Reimplemented from ObjexxFCL::FArray5< T >.

template<typename T>

friend class FArray5P< T > [friend]

template<typename T>

FArray5D operator*	(	Super const &	a,
		T const &	t
	)		[friend]

Array * Value.

template<typename T>

FArray5D operator*	(	T const &	t,
		Super const &	a
	)		[friend]

Value * Array.

template<typename T>

FArray5D operator+	(	Super const &	a,
		T const &	t
	)		[friend]

Array + Value.

template<typename T>

FArray5D operator+	(	T const &	t,
		Super const &	a
	)		[friend]

Value + Array.

template<typename T>

FArray5D operator+	(	Super const &	a,
		Super const &	b
	)		[friend]

Array + Array.

template<typename T>

FArray5D operator-	(	Super const &	a,
		Super const &	b
	)		[friend]

Array - Array.

template<typename T>

FArray5D operator-	(	Super const &	a,
		T const &	t
	)		[friend]

Array - Value.

template<typename T>

FArray5D operator-

(

Super const &

a

)

[friend]

-Array

template<typename T>

FArray5D operator-	(	T const &	t,
		Super const &	a
	)		[friend]

Value - Array.

template<typename T>

FArray5D operator/	(	Super const &	a,
		T const &	t
	)		[friend]

Array / Value.

template<typename T>

void swap	(	FArray5D< T > &	a,
		FArray5D< T > &	b
	)		[friend]

Swap.

---

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

• src/ObjexxFCL/FArray5D.hh