FArray2: Fortran-Compatible 2D Array Abstract Base Class. More...

#include <FArray2.hh>

Inheritance diagram for ObjexxFCL::FArray2< T >:

[legend]

Public Types
typedef Super::Base	Base

typedef Base::Section	Section

typedef Base::IR	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

Public Types inherited from ObjexxFCL::FArray< T >
typedef FArray< T >	Base

typedef FArrayTraits< T >	Traits

typedef FArraySection< T >	Section

typedef IndexRange	IR

typedef T	value_type

typedef T &	reference

typedef T const &	const_reference

typedef T *	pointer

typedef T const *	const_pointer

typedef std::size_t	size_type

typedef std::ptrdiff_t	difference_type

typedef T	Value

typedef T &	Reference

typedef T const &	ConstReference

typedef T *	Pointer

typedef T const *	ConstPointer

typedef std::size_t	Size

typedef std::ptrdiff_t	Difference

Public Member Functions
	~FArray2 () override
	Destructor. More...

FArray2 &	operator= (FArray2 const &a)
	Copy Assignment. More...

template<typename U >
FArray2 &	operator= (FArray2< U > const &a)
	Copy Assignment Template. More...

template<typename U >
FArray2 &	operator+= (FArray2< U > const &a)
	+= Array Template More...

template<typename U >
FArray2 &	operator-= (FArray2< U > const &a)
	-= Array Template More...

template<typename U >
FArray2 &	operator*= (FArray2< U > const &a)
	*= Array Template More...

FArray2 &	operator= (T const &t)
	= Value More...

FArray2 &	operator+= (T const &t)
	+= Value More...

FArray2 &	operator-= (T const &t)
	-= Value More...

FArray2 &	operator*= (T const &t)
	*= Value More...

FArray2 &	operator/= (T const &t)
	/= Value More...

T const &	operator() (int const i1, int const i2) const
	array( i1, i2 ) const More...

T &	operator() (int const i1, int const i2)
	array( i1, i2 ) More...

Section const	a (int const i1, int const i2) const
	Const Section Starting at array( i1, i2 ) More...

Section	a (int const i1, int const i2)
	Section Starting at array( i1, i2 ) More...

size_type	index (int const i1, int const i2) const
	Linear Index. More...

virtual bool	contains (int const i1, int const i2) const
	Contains Indexed Element? More...

template<typename U >
bool	equal_dimension (FArray2< U > const &a) const
	Equal Dimension? More...

bool	is_identity () const
	Is Identity? More...

bool	square () const
	Square? More...

bool	symmetric () const
	Symmetric? More...

virtual IR const &	I1 () const =0
	IndexRange of Dimension 1. More...

virtual int	l1 () const =0
	Lower Index of Dimension 1. More...

virtual int	u1 () const =0
	Upper Index of Dimension 1. More...

size_type	size1 () const
	Size of Dimension 1. More...

virtual IR const &	I2 () const =0
	IndexRange of Dimension 2. More...

virtual int	l2 () const =0
	Lower Index of Dimension 2. More...

virtual int	u2 () const =0
	Upper Index of Dimension 2. More...

virtual size_type	size2 () const =0
	Size of Dimension 2. More...

FArray2 &	clear () override
	Clear. More...

FArray2 &	to_default () override
	Assign Default Value to all Elements. More...

FArray2 &	to_identity ()
	Set to the Identity Matrix. More...

FArray2 &	to_diag (T const &d)
	Set to Diagonal Matrix with Uniform Value. More...

FArray2 &	set_diagonal (T const &d)
	Set Diagonal of Matrix to a Uniform Value. More...

FArray2 &	transpose ()
	Transpose. More...

template<typename U >
FArray2 &	right_multiply_by (FArray2< U > const &a)
	Right Multiply By Array. More...

template<typename U >
FArray2 &	right_multiply_by_transpose (FArray2< U > const &a)
	Right Multiply By Transpose of Array. More...

virtual bool	dimensions_initialized () const=0
	Dimensions Initialized? More...

Public Member Functions inherited from ObjexxFCL::FArray< T >
virtual	~FArray ()
	Destructor. More...

FArray &	operator= (T const &t)
	= Value More...

FArray &	operator+= (T const &t)
	+= Value More...

FArray &	operator-= (T const &t)
	-= Value More...

FArray &	operator*= (T const &t)
	*= Value More...

FArray &	operator/= (T const &t)
	/= Value More...

T const &	operator[] (size_type const i) const
	array[ i ] const: Linear Subscript More...

T &	operator[] (size_type const i)
	array[ i ]: Linear Subscript More...

virtual bool	dimensions_initialized () const =0
	Dimensions Initialized? More...

virtual bool	initializer_active () const =0
	Initializer Active? More...

bool	active () const
	Active? More...

bool	array_size_bounded () const
	Array Size Bounded? More...

bool	array_size_unbounded () const
	Array Size Unbounded? More...

bool	size_bounded () const
	Active Array Size Bounded? More...

bool	size_unbounded () const
	Active Array Size Unbounded? More...

bool	owner () const
	Owner? More...

bool	proxy () const
	Proxy? More...

bool	is_default () const
	All Elements Default Valued? More...

bool	is_zero () const
	All Elements Zero? More...

bool	is_uniform () const
	Uniform Valued? More...

bool	is_uniform (T const &t) const
	Uniform Valued with Specified Value? More...

size_type	array_size () const
	Array Size. More...

size_type	size () const
	Active Array Size. More...

void	zero ()
	Assign Zero to all Elements. More...

void	to_zero ()
	Assign Zero to all Elements. More...

Public Attributes
T *	array_
	Pointer to data array. More...

size_type	array_size_
	Size of data array. More...

T *	sarray_
	Shifted pointer to data array. More...

int	shift_
	Array shift. More...

Static Public Attributes
static size_type const	npos
	Unbounded "size". More...

Static Public Attributes inherited from ObjexxFCL::FArray< T >
static size_type const	npos = static_cast< size_type >( -1 )
	Unbounded "size". More...

static size_type const	max_size = npos - static_cast< size_type >( 1 )
	Max array size. More...

Protected Types
typedef internal::InitializerSentinel	InitializerSentinel

typedef internal::ProxySentinel	ProxySentinel

Protected Types inherited from ObjexxFCL::FArray< T >
typedef internal::InitializerSentinel	InitializerSentinel

typedef internal::ProxySentinel	ProxySentinel

Protected Member Functions
	FArray2 ()
	Default Constructor. More...

	FArray2 (FArray2 const &a)
	Copy Constructor. More...

	FArray2 (FArray2 const &a, T const &v)
	Filled Copy Constructor - use the other data from the array, but fill with the given value. More...

template<typename U >
	FArray2 (FArray2< U > const &a)
	Copy Constructor Template. More...

	FArray2 (size_type const size_a)
	Size Constructor. More...

	FArray2 (size_type const size_a, InitializerSentinel const &initialized)
	Size + InitializerSentinel Constructor. More...

	FArray2 (ProxySentinel const &proxy)
	Default Proxy Constructor. More...

	FArray2 (FArray2 const &a, ProxySentinel const &proxy)
	Copy Proxy Constructor. More...

	FArray2 (FArray2 &a, ProxySentinel const &proxy)
	Non-Const Copy Proxy Constructor. More...

	FArray2 (Base const &a, ProxySentinel const &proxy)
	Base Proxy Constructor. More...

	FArray2 (Base &a, ProxySentinel const &proxy)
	Non-Const Base Proxy Constructor. More...

	FArray2 (Section const &s, ProxySentinel const &proxy)
	Section Proxy Constructor. More...

	FArray2 (Section &s, ProxySentinel const &proxy)
	Non-Const Section Proxy Constructor. More...

	FArray2 (T const &t, ProxySentinel const &proxy)
	Value Proxy Constructor. More...

	FArray2 (T &t, ProxySentinel const &proxy)
	Non-Const Value Proxy Constructor. More...

virtual void	dimension_assign (IR const &I1_a, IR const &I2_a)=0
	Dimension by IndexRanges. More...

void	swap2DB (FArray2 &v)
	Swap. More...

Protected Member Functions inherited from ObjexxFCL::FArray< T >
	FArray ()
	Default Constructor. More...

	FArray (FArray const &a)
	Copy Constructor. More...

	FArray (FArray const &a, T const &v)
	Filled Copy Constructor - use the other data from the array, but fill with the given value. More...

template<typename U >
	FArray (FArray< U > const &a)
	Copy Constructor Template. More...

	FArray (size_type const size_a)
	Size Constructor. More...

	FArray (size_type const size_a, InitializerSentinel const &)
	Size + InitializerSentinel Constructor. More...

	FArray (ProxySentinel const &)
	Default Proxy Constructor. More...

	FArray (FArray const &a, ProxySentinel const &)
	Array Proxy Constructor. More...

	FArray (FArray &a, ProxySentinel const &)
	Non-Const Array Proxy Constructor. More...

	FArray (Section const &s, ProxySentinel const &)
	Section Proxy Constructor. More...

	FArray (Section &s, ProxySentinel const &)
	Non-Const Section Proxy Constructor. More...

	FArray (T const &t, ProxySentinel const &)
	Value Proxy Constructor. More...

	FArray (T &t, ProxySentinel const &)
	Non-Const Value Proxy Constructor. More...

FArray &	operator= (FArray const &a)
	Copy Assignment. More...

template<typename U >
void	operator= (FArray< U > const &a)
	Copy Assignment Template. More...

template<typename U >
void	operator+= (FArray< U > const &a)
	+= Array Template More...

template<typename U >
void	operator-= (FArray< U > const &a)
	-= Array Template More...

void	shift_set (int const shift_a)
	Shift Setup. More...

void	size_set (size_type const size_a)
	Active Array Size Setup. More...

FArray &	resize (size_type const size_a)
	Resize a Real Array. More...

void	attach (FArray const &a)
	Attach Proxy/Argument Array to Const Array of Same Rank. More...

void	attach (FArray &a)
	Attach Proxy/Argument Array to Array of Same Rank. More...

void	attach (FArray const &a, int const shift_a)
	Attach Proxy/Argument Array to Const Array. More...

void	attach (FArray &a, int const shift_a)
	Attach Proxy/Argument Array to Array. More...

void	attach (Section const &s, int const shift_a)
	Attach Proxy/Argument Array to Const Section. More...

void	attach (Section &s, int const shift_a)
	Attach Proxy/Argument Array to Section. More...

void	attach (T const &t, int const shift_a)
	Attach Proxy/Argument Array to Const Value. More...

void	attach (T &t, int const shift_a)
	Attach Proxy/Argument Array to Value. More...

void	detach ()
	Detach Proxy/Argument Array. More...

void	update_to (FArray const &a)
	Update Proxy Array Attachment to Const Array. More...

void	update_to (FArray &a)
	Update Proxy Array Attachment to Array. More...

void	swapB (FArray &v)
	Swap. More...

Protected Attributes
size_type	s1_
	Dimension 1 size. More...

Protected Attributes inherited from ObjexxFCL::FArray< T >
size_type	array_size_
	Size of data array. More...

T *	array_
	Pointer to data array. More...

size_type	size_
	Size of active array. More...

bool const	owner_
	Owner of data array? More...

int	shift_
	Array shift. More...

T *	sarray_
	Shifted pointer to data array. More...

Private Types
typedef FArray< T >	Super

typedef FArray2D< T >	real_FArray

typedef FArray2P< T >	proxy_FArray

typedef FArray2A< T >	arg_FArray

Friends
template<typename >
class	FArray2

template<typename >
class	FArray2D

template<typename >
class	FArray2P

template<typename >
class	FArray2A

template<typename >
class	KeyFArray2D

bool	operator== (FArray2 const &a, FArray2 const &b)
	FArray2 == FArray2. More...

bool	operator!= (FArray2 const &a, FArray2 const &b)
	FArray2 != FArray2. More...

Additional Inherited Members
Static Protected Member Functions inherited from ObjexxFCL::FArray< T >
static size_type	size_of (size_type const s1)
	Array Size Product of Specified Bounded Dimensional Sizes. More...

static size_type	size_of (size_type const s1, size_type const s2)
	Array Size Product of Specified Bounded Dimensional Sizes. More...

static size_type	size_of (size_type const s1, size_type const s2, size_type const s3)
	Array Size Product of Specified Bounded Dimensional Sizes. More...

static size_type	size_of (size_type const s1, size_type const s2, size_type const s3, size_type const s4)
	Array Size Product of Specified Bounded Dimensional Sizes. More...

static size_type	size_of (size_type const s1, size_type const s2, size_type const s3, size_type const s4, size_type const s5)
	Array Size Product of Specified Bounded Dimensional Sizes. More...

static size_type	size_of (size_type const s1, size_type const s2, size_type const s3, size_type const s4, size_type const s5, size_type const s6)
	Array Size Product of Specified Bounded Dimensional Sizes. More...

static size_type	size_of (IR const &I1)
	Array Size Product of Specified Bounded IndexRanges. More...

static size_type	size_of (IR const &I1, IR const &I2)
	Array Size Product of Specified Bounded IndexRanges. More...

static size_type	size_of (IR const &I1, IR const &I2, IR const &I3)
	Array Size Product of Specified Bounded IndexRanges. More...

static size_type	size_of (IR const &I1, IR const &I2, IR const &I3, IR const &I4)
	Array Size Product of Specified Bounded IndexRanges. More...

static size_type	size_of (IR const &I1, IR const &I2, IR const &I3, IR const &I4, IR const &I5)
	Array Size Product of Specified Bounded IndexRanges. More...

static size_type	size_of (IR const &I1, IR const &I2, IR const &I3, IR const &I4, IR const &I5, IR const &I6)
	Array Size Product of Specified Bounded IndexRanges. More...

Detailed Description

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

FArray2: Fortran-Compatible 2D Array Abstract Base Class.

Member Typedef Documentation

◆ arg_FArray

template<typename T >

typedef FArray2A< T > ObjexxFCL::FArray2< T >::arg_FArray

private

◆ Base

template<typename T >

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

◆ const_pointer

template<typename T >

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

◆ const_reference

template<typename T >

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

◆ ConstPointer

template<typename T >

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

◆ ConstReference

template<typename T >

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

◆ Difference

template<typename T >

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

◆ difference_type

template<typename T >

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

◆ InitializerSentinel

template<typename T >

typedef internal::InitializerSentinel ObjexxFCL::FArray2< T >::InitializerSentinel

protected

◆ IR

template<typename T >

typedef Base::IR ObjexxFCL::FArray2< T >::IR

◆ pointer

template<typename T >

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

◆ Pointer

template<typename T >

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

◆ proxy_FArray

template<typename T >

typedef FArray2P< T > ObjexxFCL::FArray2< T >::proxy_FArray

private

◆ ProxySentinel

template<typename T >

typedef internal::ProxySentinel ObjexxFCL::FArray2< T >::ProxySentinel

protected

◆ real_FArray

template<typename T >

typedef FArray2D< T > ObjexxFCL::FArray2< T >::real_FArray

private

◆ reference

template<typename T >

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

◆ Reference

template<typename T >

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

◆ Section

template<typename T >

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

◆ Size

template<typename T >

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

◆ size_type

template<typename T >

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

◆ Super

template<typename T >

typedef FArray< T > ObjexxFCL::FArray2< T >::Super

private

◆ Value

template<typename T >

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

◆ value_type

template<typename T >

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

Constructor & Destructor Documentation

◆ FArray2() [1/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2 ( )

inlineprotected

Default Constructor.

◆ FArray2() [2/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2 ( FArray2< T > const & a )

inlineprotected

Copy Constructor.

◆ FArray2() [3/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	FArray2< T > const &	a,
		T const &	v
	)

inlineprotected

Filled Copy Constructor - use the other data from the array, but fill with the given value.

◆ FArray2() [4/15]

template<typename T >

template<typename U >

ObjexxFCL::FArray2< T >::FArray2 ( FArray2 const & a )

inlineexplicitprotected

Copy Constructor Template.

◆ FArray2() [5/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2 ( size_type const size_a )

inlineexplicitprotected

Size Constructor.

◆ FArray2() [6/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	size_type const	size_a,
		InitializerSentinel const &	initialized
	)

inlineprotected

Size + InitializerSentinel Constructor.

◆ FArray2() [7/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2 ( ProxySentinel const & proxy )

inlineprotected

Default Proxy Constructor.

◆ FArray2() [8/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	FArray2< T > const &	a,
		ProxySentinel const &	proxy
	)

inlineprotected

Copy Proxy Constructor.

◆ FArray2() [9/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	FArray2< T > &	a,
		ProxySentinel const &	proxy
	)

inlineprotected

Non-Const Copy Proxy Constructor.

◆ FArray2() [10/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	Base const &	a,
		ProxySentinel const &	proxy
	)

inlineprotected

Base Proxy Constructor.

◆ FArray2() [11/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	Base &	a,
		ProxySentinel const &	proxy
	)

inlineprotected

Non-Const Base Proxy Constructor.

◆ FArray2() [12/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	Section const &	s,
		ProxySentinel const &	proxy
	)

inlineprotected

Section Proxy Constructor.

◆ FArray2() [13/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	Section &	s,
		ProxySentinel const &	proxy
	)

inlineprotected

Non-Const Section Proxy Constructor.

◆ FArray2() [14/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	T const &	t,
		ProxySentinel const &	proxy
	)

inlineprotected

Value Proxy Constructor.

◆ FArray2() [15/15]

template<typename T >

ObjexxFCL::FArray2< T >::FArray2	(	T &	t,
		ProxySentinel const &	proxy
	)

inlineprotected

Non-Const Value Proxy Constructor.

◆ ~FArray2()

template<typename T >

ObjexxFCL::FArray2< T >::~FArray2 ( )

inlineoverride

Destructor.

Member Function Documentation

◆ a() [1/2]

template<typename T >

Section ObjexxFCL::FArray2< T >::a	(	int const	i1,
		int const	i2
	)

inline

Section Starting at array( i1, i2 )

References ObjexxFCL::FArray2< T >::array_, ObjexxFCL::FArray2< T >::array_size_, ObjexxFCL::FArray2< T >::contains(), ObjexxFCL::FArray2< T >::npos, offset, proxy_const_assert, ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray2< T >::shift_.

◆ a() [2/2]

template<typename T >

Section const ObjexxFCL::FArray2< T >::a	(	int const	i1,
		int const	i2
	)		const

inline

Const Section Starting at array( i1, i2 )

References ObjexxFCL::FArray2< T >::array_, ObjexxFCL::FArray2< T >::array_size_, ObjexxFCL::FArray2< T >::contains(), ObjexxFCL::FArray2< T >::npos, offset, ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray2< T >::shift_.

Referenced by ObjexxFCL::FArray2< T >::equal_dimension(), ObjexxFCL::FArray2< T >::operator*=(), ObjexxFCL::FArray2< T >::operator+=(), ObjexxFCL::FArray2< T >::operator-=(), ObjexxFCL::FArray2< T >::operator=(), ObjexxFCL::FArray2< T >::right_multiply_by(), and ObjexxFCL::FArray2< T >::right_multiply_by_transpose().

◆ clear()

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::clear ( )

inlineoverridevirtual

Clear.

Reimplemented from ObjexxFCL::FArray< T >.

Reimplemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

References ObjexxFCL::FArray< T >::clear(), and ObjexxFCL::FArray2< T >::s1_.

Referenced by ObjexxFCL::KeyFArray2D< T >::clear(), ObjexxFCL::FArray2A< T >::clear(), ObjexxFCL::FArray2D< T >::clear(), ObjexxFCL::FArray2P< T >::clear(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ contains()

template<typename T >

virtual bool ObjexxFCL::FArray2< T >::contains	(	int const	i1,
		int const	i2
	)		const

inlinevirtual

Contains Indexed Element?

Reimplemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, and ObjexxFCL::FArray2A< T >.

References ObjexxFCL::FArray2< T >::I1(), and ObjexxFCL::FArray2< T >::I2().

Referenced by ObjexxFCL::FArray2< T >::a(), and ObjexxFCL::FArray2< T >::operator()().

◆ dimension_assign()

template<typename T >

virtual void ObjexxFCL::FArray2< T >::dimension_assign	(	IR const &	I1_a,
		IR const &	I2_a
	)

protectedpure virtual

Dimension by IndexRanges.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

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

◆ dimensions_initialized()

template<typename T >

virtual bool ObjexxFCL::FArray< T >::dimensions_initialized

Dimensions Initialized?

Referenced by ObjexxFCL::FArray2< T >::index(), and ObjexxFCL::FArray2< T >::square().

◆ equal_dimension()

template<typename T >

template<typename U >

bool ObjexxFCL::FArray2< T >::equal_dimension ( FArray2 const & a ) const

inline

Equal Dimension?

References ObjexxFCL::FArray2< T >::a(), ObjexxFCL::FArray2< T >::I1(), and ObjexxFCL::FArray2< T >::I2().

Referenced by ObjexxFCL::FArray2< T >::operator+=(), ObjexxFCL::FArray2< T >::operator-=(), ObjexxFCL::FArray2< T >::operator=(), ObjexxFCL::FArray2A< T >::operator=(), ObjexxFCL::FArray2D< T >::operator=(), ObjexxFCL::FArray2P< T >::operator=(), and ObjexxFCL::KeyFArray2D< T >::operator=().

◆ I1()

template<typename T >

virtual IR const& ObjexxFCL::FArray2< T >::I1 ( ) const

pure virtual

IndexRange of Dimension 1.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

Referenced by ObjexxFCL::FArray2< T >::contains(), ObjexxFCL::FArray2< T >::equal_dimension(), and ObjexxFCL::FArray2< T >::symmetric().

◆ I2()

template<typename T >

virtual IR const& ObjexxFCL::FArray2< T >::I2 ( ) const

pure virtual

IndexRange of Dimension 2.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

Referenced by ObjexxFCL::FArray2< T >::contains(), ObjexxFCL::FArray2< T >::equal_dimension(), and ObjexxFCL::FArray2< T >::symmetric().

◆ index()

template<typename T >

size_type ObjexxFCL::FArray2< T >::index	(	int const	i1,
		int const	i2
	)		const

inline

Linear Index.

References ObjexxFCL::FArray2< T >::dimensions_initialized(), ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray2< T >::shift_.

◆ is_identity()

template<typename T >

bool ObjexxFCL::FArray2< T >::is_identity ( ) const

inline

Is Identity?

References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, create_a3b_hbs::i, create_a3b_hbs::j, ObjexxFCL::FArray2< T >::l1(), ObjexxFCL::FArray2< T >::l2(), ObjexxFCL::FArray2< T >::square(), ObjexxFCL::FArray2< T >::u1(), and ObjexxFCL::FArray2< T >::u2().

◆ l1()

template<typename T >

virtual int ObjexxFCL::FArray2< T >::l1 ( ) const

pure virtual

Lower Index of Dimension 1.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

Referenced by ObjexxFCL::FArray2< T >::is_identity(), ObjexxFCL::FArray2< T >::operator*=(), ObjexxFCL::FArray2< T >::right_multiply_by_transpose(), ObjexxFCL::FArray2< T >::set_diagonal(), ObjexxFCL::FArray2< T >::symmetric(), ObjexxFCL::FArray2< T >::to_diag(), ObjexxFCL::FArray2< T >::to_identity(), and ObjexxFCL::FArray2< T >::transpose().

◆ l2()

template<typename T >

virtual int ObjexxFCL::FArray2< T >::l2 ( ) const

pure virtual

Lower Index of Dimension 2.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

Referenced by ObjexxFCL::FArray2< T >::is_identity(), ObjexxFCL::FArray2< T >::operator*=(), ObjexxFCL::FArray2< T >::right_multiply_by_transpose(), ObjexxFCL::FArray2< T >::set_diagonal(), ObjexxFCL::FArray2< T >::symmetric(), ObjexxFCL::FArray2< T >::to_diag(), ObjexxFCL::FArray2< T >::to_identity(), and ObjexxFCL::FArray2< T >::transpose().

◆ operator()() [1/2]

template<typename T >

T& ObjexxFCL::FArray2< T >::operator()	(	int const	i1,
		int const	i2
	)

inline

array( i1, i2 )

References ObjexxFCL::FArray2< T >::contains(), proxy_const_assert, ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray2< T >::sarray_.

◆ operator()() [2/2]

template<typename T >

T const& ObjexxFCL::FArray2< T >::operator()	(	int const	i1,
		int const	i2
	)		const

inline

array( i1, i2 ) const

References ObjexxFCL::FArray2< T >::contains(), ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray2< T >::sarray_.

◆ operator*=() [1/2]

template<typename T >

template<typename U >

FArray2& ObjexxFCL::FArray2< T >::operator*= ( FArray2 const & a )

inline

◆ operator*=() [2/2]

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::operator*= ( T const & t )

inline

*= Value

References ObjexxFCL::FArray< T >::operator*=(), and predPRE::t.

◆ operator+=() [1/2]

template<typename T >

template<typename U >

FArray2& ObjexxFCL::FArray2< T >::operator+= ( FArray2 const & a )

inline

+= Array Template

References ObjexxFCL::FArray2< T >::a(), ObjexxFCL::FArray2< T >::equal_dimension(), and ObjexxFCL::FArray< T >::operator+=().

Referenced by ObjexxFCL::FArray2A< T >::operator+=(), ObjexxFCL::FArray2D< T >::operator+=(), ObjexxFCL::FArray2P< T >::operator+=(), and ObjexxFCL::KeyFArray2D< T >::operator+=().

◆ operator+=() [2/2]

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::operator+= ( T const & t )

inline

+= Value

References ObjexxFCL::FArray< T >::operator+=(), and predPRE::t.

◆ operator-=() [1/2]

template<typename T >

template<typename U >

FArray2& ObjexxFCL::FArray2< T >::operator-= ( FArray2 const & a )

inline

-= Array Template

References ObjexxFCL::FArray2< T >::a(), ObjexxFCL::FArray2< T >::equal_dimension(), and ObjexxFCL::FArray< T >::operator-=().

Referenced by ObjexxFCL::FArray2A< T >::operator-=(), ObjexxFCL::FArray2D< T >::operator-=(), ObjexxFCL::FArray2P< T >::operator-=(), and ObjexxFCL::KeyFArray2D< T >::operator-=().

◆ operator-=() [2/2]

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::operator-= ( T const & t )

inline

-= Value

References ObjexxFCL::FArray< T >::operator-=(), and predPRE::t.

◆ operator/=()

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::operator/= ( T const & t )

inline

/= Value

References ObjexxFCL::FArray< T >::operator/=(), and predPRE::t.

Referenced by ObjexxFCL::FArray2A< T >::operator/=(), ObjexxFCL::FArray2D< T >::operator/=(), ObjexxFCL::FArray2P< T >::operator/=(), and ObjexxFCL::KeyFArray2D< T >::operator/=().

◆ operator=() [1/3]

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::operator= ( FArray2< T > const & a )

inline

Copy Assignment.

References ObjexxFCL::FArray2< T >::a(), ObjexxFCL::FArray2< T >::dimension_assign(), ObjexxFCL::FArray2< T >::equal_dimension(), and ObjexxFCL::FArray< T >::operator=().

Referenced by ObjexxFCL::FArray2A< T >::operator=(), ObjexxFCL::FArray2D< T >::operator=(), ObjexxFCL::FArray2P< T >::operator=(), and ObjexxFCL::KeyFArray2D< T >::operator=().

◆ operator=() [2/3]

template<typename T >

template<typename U >

FArray2& ObjexxFCL::FArray2< T >::operator= ( FArray2 const & a )

inline

Copy Assignment Template.

References ObjexxFCL::FArray2< T >::a(), ObjexxFCL::FArray2< T >::dimension_assign(), ObjexxFCL::FArray2< T >::equal_dimension(), and ObjexxFCL::FArray< T >::operator=().

◆ operator=() [3/3]

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::operator= ( T const & t )

inline

= Value

References ObjexxFCL::FArray< T >::operator=(), and predPRE::t.

◆ right_multiply_by()

template<typename T >

template<typename U >

FArray2& ObjexxFCL::FArray2< T >::right_multiply_by ( FArray2 const & a )

inline

Right Multiply By Array.

References ObjexxFCL::FArray2< T >::a(), and proxy_const_assert.

◆ right_multiply_by_transpose()

template<typename T >

template<typename U >

FArray2& ObjexxFCL::FArray2< T >::right_multiply_by_transpose ( FArray2 const & a )

inline

Right Multiply By Transpose of Array.

References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, ObjexxFCL::FArray2< T >::a(), create_a3b_hbs::i, create_a3b_hbs::ii, create_a3b_hbs::j, beta_nonlocal::jj, create_a3b_hbs::k, ObjexxFCL::FArray2< T >::l1(), ObjexxFCL::FArray2< T >::l2(), proxy_const_assert, dummy-distribution::row, ObjexxFCL::FArray2< T >::size2(), sum(), pyrosetta.distributed.cluster.exceptions::T, ObjexxFCL::FArray2< T >::u1(), and ObjexxFCL::FArray2< T >::u2().

◆ set_diagonal()

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::set_diagonal ( T const & d )

inline

Set Diagonal of Matrix to a Uniform Value.

References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, test.T009_Exceptions::e, create_a3b_hbs::i, create_a3b_hbs::j, ObjexxFCL::FArray2< T >::l1(), ObjexxFCL::FArray2< T >::l2(), proxy_const_assert, ObjexxFCL::FArray2< T >::square(), and ObjexxFCL::FArray2< T >::u1().

◆ size1()

template<typename T >

size_type ObjexxFCL::FArray2< T >::size1 ( ) const

inline

Size of Dimension 1.

References ObjexxFCL::FArray2< T >::s1_.

Referenced by normalize_info(), ObjexxFCL::FArray2< T >::operator*=(), and output_ss_info().

◆ size2()

template<typename T >

virtual size_type ObjexxFCL::FArray2< T >::size2 ( ) const

pure virtual

Size of Dimension 2.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

Referenced by ObjexxFCL::FArray2< T >::operator*=(), ObjexxFCL::FArray2< T >::right_multiply_by_transpose(), and ObjexxFCL::FArray2< T >::square().

◆ square()

template<typename T >

bool ObjexxFCL::FArray2< T >::square ( ) const

inline

Square?

References ObjexxFCL::FArray2< T >::dimensions_initialized(), ObjexxFCL::FArray2< T >::s1_, and ObjexxFCL::FArray2< T >::size2().

Referenced by ObjexxFCL::FArray2< T >::is_identity(), ObjexxFCL::FArray2< T >::set_diagonal(), ObjexxFCL::FArray2< T >::to_diag(), ObjexxFCL::FArray2< T >::to_identity(), and ObjexxFCL::FArray2< T >::transpose().

◆ swap2DB()

template<typename T >

void ObjexxFCL::FArray2< T >::swap2DB ( FArray2< T > & v )

inlineprotected

Swap.

References ObjexxFCL::FArray2< T >::s1_, swap(), ObjexxFCL::FArray< T >::swapB(), and kmeans_adaptive_kernel_density_bb_dependent_rotlib::v.

Referenced by ObjexxFCL::FArray2D< T >::swap(), and ObjexxFCL::KeyFArray2D< T >::swap().

◆ symmetric()

template<typename T >

bool ObjexxFCL::FArray2< T >::symmetric ( ) const

inline

Symmetric?

References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, create_a3b_hbs::i, ObjexxFCL::FArray2< T >::I1(), ObjexxFCL::FArray2< T >::I2(), create_a3b_hbs::j, ObjexxFCL::FArray2< T >::l1(), ObjexxFCL::FArray2< T >::l2(), and ObjexxFCL::FArray2< T >::u1().

◆ to_default()

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::to_default ( )

inlineoverridevirtual

Assign Default Value to all Elements.

Reimplemented from ObjexxFCL::FArray< T >.

References ObjexxFCL::FArray< T >::to_default().

◆ to_diag()

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::to_diag ( T const & d )

inline

Set to Diagonal Matrix with Uniform Value.

References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, test.T009_Exceptions::e, create_a3b_hbs::i, create_a3b_hbs::j, ObjexxFCL::FArray2< T >::l1(), ObjexxFCL::FArray2< T >::l2(), proxy_const_assert, ObjexxFCL::FArray2< T >::square(), pyrosetta.distributed.cluster.exceptions::T, and ObjexxFCL::FArray2< T >::u1().

◆ to_identity()

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::to_identity ( )

inline

Set to the Identity Matrix.

References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, test.T009_Exceptions::e, create_a3b_hbs::i, create_a3b_hbs::j, ObjexxFCL::FArray2< T >::l1(), ObjexxFCL::FArray2< T >::l2(), proxy_const_assert, ObjexxFCL::FArray2< T >::square(), pyrosetta.distributed.cluster.exceptions::T, and ObjexxFCL::FArray2< T >::u1().

◆ transpose()

template<typename T >

FArray2& ObjexxFCL::FArray2< T >::transpose ( )

inline

Transpose.

References spectral_cluster_kmeans_adaptive_kernel_density_bb_dependent_rotlib::A, create_a3b_hbs::i, create_a3b_hbs::j, ObjexxFCL::FArray2< T >::l1(), ObjexxFCL::FArray2< T >::l2(), proxy_const_assert, ObjexxFCL::FArray2< T >::square(), and ObjexxFCL::FArray2< T >::u1().

◆ u1()

template<typename T >

virtual int ObjexxFCL::FArray2< T >::u1 ( ) const

pure virtual

Upper Index of Dimension 1.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

Referenced by ObjexxFCL::FArray2< T >::is_identity(), ObjexxFCL::FArray2< T >::operator*=(), ObjexxFCL::FArray2< T >::right_multiply_by_transpose(), ObjexxFCL::FArray2< T >::set_diagonal(), ObjexxFCL::FArray2< T >::symmetric(), ObjexxFCL::FArray2< T >::to_diag(), ObjexxFCL::FArray2< T >::to_identity(), and ObjexxFCL::FArray2< T >::transpose().

◆ u2()

template<typename T >

virtual int ObjexxFCL::FArray2< T >::u2 ( ) const

pure virtual

Upper Index of Dimension 2.

Implemented in ObjexxFCL::FArray2P< T >, ObjexxFCL::FArray2D< T >, ObjexxFCL::FArray2D< numeric::xyzVector >, ObjexxFCL::FArray2D< double >, ObjexxFCL::FArray2D< float >, ObjexxFCL::FArray2D< core::Real >, ObjexxFCL::FArray2A< T >, and ObjexxFCL::KeyFArray2D< T >.

Referenced by ObjexxFCL::FArray2< T >::is_identity(), ObjexxFCL::FArray2< T >::operator*=(), and ObjexxFCL::FArray2< T >::right_multiply_by_transpose().

Friends And Related Function Documentation

◆ FArray2

template<typename T >

template<typename >

friend class FArray2

friend

◆ FArray2A

template<typename T >

template<typename >

friend class FArray2A

friend

◆ FArray2D

template<typename T >

template<typename >

friend class FArray2D

friend

◆ FArray2P

template<typename T >

template<typename >

friend class FArray2P

friend

◆ KeyFArray2D

template<typename T >

template<typename >

friend class KeyFArray2D

friend

◆ operator!=

template<typename T >

bool operator!=	(	FArray2< T > const &	a,
		FArray2< T > const &	b
	)

friend

FArray2 != FArray2.

◆ operator==

template<typename T >

bool operator==	(	FArray2< T > const &	a,
		FArray2< T > const &	b
	)

friend

FArray2 == FArray2.

Member Data Documentation

◆ array_

template<typename T >

T* ObjexxFCL::FArray< T >::array_

Pointer to data array.

Referenced by ObjexxFCL::FArray2< T >::a().

◆ array_size_

template<typename T >

size_type ObjexxFCL::FArray< T >::array_size_

Size of data array.

Referenced by ObjexxFCL::FArray2< T >::a().

◆ npos

template<typename T >

FArray< T >::size_type const ObjexxFCL::FArray< T >::npos

static

Unbounded "size".

Referenced by ObjexxFCL::FArray2< T >::a().

◆ s1_

template<typename T >

size_type ObjexxFCL::FArray2< T >::s1_

protected

Dimension 1 size.

◆ sarray_

template<typename T >

T* ObjexxFCL::FArray< T >::sarray_

Shifted pointer to data array.

Referenced by ObjexxFCL::FArray2< T >::operator()().

◆ shift_

template<typename T >

int ObjexxFCL::FArray< T >::shift_

Array shift.

Referenced by ObjexxFCL::FArray2< T >::a(), and ObjexxFCL::FArray2< T >::index().

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

src/ObjexxFCL/FArray2.fwd.hh
src/ObjexxFCL/FArray2.hh

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Friends

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ arg_FArray

◆ Base

◆ const_pointer

◆ const_reference

◆ ConstPointer

◆ ConstReference

◆ Difference

◆ difference_type

◆ InitializerSentinel

◆ IR

◆ pointer

◆ Pointer

◆ proxy_FArray

◆ ProxySentinel

◆ real_FArray

◆ reference

◆ Reference

◆ Section

◆ Size

◆ size_type

◆ Super

◆ Value

◆ value_type

Constructor & Destructor Documentation

◆ FArray2() [1/15]

◆ FArray2() [2/15]

◆ FArray2() [3/15]

◆ FArray2() [4/15]

◆ FArray2() [5/15]

◆ FArray2() [6/15]

◆ FArray2() [7/15]

◆ FArray2() [8/15]

◆ FArray2() [9/15]

◆ FArray2() [10/15]

◆ FArray2() [11/15]

◆ FArray2() [12/15]

◆ FArray2() [13/15]

◆ FArray2() [14/15]

◆ FArray2() [15/15]

◆ ~FArray2()

Member Function Documentation

◆ a() [1/2]

◆ a() [2/2]

◆ clear()

◆ contains()

◆ dimension_assign()

◆ dimensions_initialized()

◆ equal_dimension()

◆ I1()

◆ I2()

◆ index()

◆ is_identity()

◆ l1()

◆ l2()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ right_multiply_by()

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