ObjexxFCL::FArrayInitializer< T, Array > Class Template Reference

FArrayInitializer: FArray Initializer Class Template. More...

#include <FArrayInitializer.hh>

Public Types
typedef FArrayTraits< T >	Traits
typedef T	value_type
typedef void(*	function_type) (Array< T > &)
typedef T	Value
typedef void(*	Function) (Array< T > &)

Public Member Functions
	FArrayInitializer ()
	Default Constructor. More...
	FArrayInitializer (T const &value_a)
	Value Constructor. More...
	FArrayInitializer (function_type const &function_a)
	Function Constructor. More...
FArrayInitializer &	operator= (T const &value_a)
	Value Assignment. More...
FArrayInitializer &	operator= (function_type const &function_a)
	Function Assignment. More...
bool	is_active () const
	Active? More...
bool	is_value () const
	Value? More...
bool	is_function () const
	Function? More...
T const &	value () const
	Value. More...
function_type const &	function () const
	Function. More...
void	clear ()
	Clear. More...

Private Types
enum	State { INACTIVE , VALUE , FUNCTION }

Private Attributes
State	state_
	State. More...
T	value_
	Value. More...
function_type	function_
	Function. More...

Detailed Description

template<typename T, template< typename > class Array>
class ObjexxFCL::FArrayInitializer< T, Array >

FArrayInitializer: FArray Initializer Class Template.

Member Typedef Documentation

Function

template<typename T , template< typename > class Array>

typedef void(* ObjexxFCL::FArrayInitializer< T, Array >::Function) (Array< T > &)

function_type

template<typename T , template< typename > class Array>

typedef void(* ObjexxFCL::FArrayInitializer< T, Array >::function_type) (Array< T > &)

Traits

template<typename T , template< typename > class Array>

typedef FArrayTraits< T > ObjexxFCL::FArrayInitializer< T, Array >::Traits

Value

template<typename T , template< typename > class Array>

typedef T ObjexxFCL::FArrayInitializer< T, Array >::Value

value_type

template<typename T , template< typename > class Array>

typedef T ObjexxFCL::FArrayInitializer< T, Array >::value_type

Member Enumeration Documentation

State

template<typename T , template< typename > class Array>

enum ObjexxFCL::FArrayInitializer::State

private

Enumerator
INACTIVE
VALUE
FUNCTION

Constructor & Destructor Documentation

FArrayInitializer() [1/3]

template<typename T , template< typename > class Array>

ObjexxFCL::FArrayInitializer< T, Array >::FArrayInitializer ( )

inline

Default Constructor.

FArrayInitializer() [2/3]

template<typename T , template< typename > class Array>

ObjexxFCL::FArrayInitializer< T, Array >::FArrayInitializer ( T const &  value_a )

inlineexplicit

Value Constructor.

FArrayInitializer() [3/3]

template<typename T , template< typename > class Array>

ObjexxFCL::FArrayInitializer< T, Array >::FArrayInitializer ( function_type const &  function_a )

inlineexplicit

Function Constructor.

Member Function Documentation

clear()

template<typename T , template< typename > class Array>

void ObjexxFCL::FArrayInitializer< T, Array >::clear ( )

inline

Clear.

References ObjexxFCL::FArrayInitializer< T, Array >::function_, ObjexxFCL::FArrayInitializer< T, Array >::INACTIVE, ObjexxFCL::FArrayTraits< T >::initial_value(), ObjexxFCL::FArrayInitializer< T, Array >::state_, and ObjexxFCL::FArrayInitializer< T, Array >::value_.

Referenced by ObjexxFCL::FArray6D< T >::clear(), ObjexxFCL::KeyFArray1D< T >::clear(), ObjexxFCL::KeyFArray2D< T >::clear(), ObjexxFCL::KeyFArray3D< T >::clear(), ObjexxFCL::KeyFArray4D< T >::clear(), ObjexxFCL::KeyFArray5D< T >::clear(), ObjexxFCL::KeyFArray6D< T >::clear(), ObjexxFCL::FArray1D< T >::clear(), ObjexxFCL::FArray2D< T >::clear(), ObjexxFCL::FArray3D< T >::clear(), ObjexxFCL::FArray4D< T >::clear(), ObjexxFCL::FArray5D< T >::clear(), ObjexxFCL::FArray2D< T >::dimension(), ObjexxFCL::KeyFArray2D< T >::dimension(), ObjexxFCL::FArray3D< T >::dimension(), ObjexxFCL::KeyFArray3D< T >::dimension(), ObjexxFCL::FArray4D< T >::dimension(), ObjexxFCL::KeyFArray4D< T >::dimension(), ObjexxFCL::FArray5D< T >::dimension(), ObjexxFCL::KeyFArray5D< T >::dimension(), ObjexxFCL::FArray6D< T >::dimension(), ObjexxFCL::KeyFArray6D< T >::dimension(), ObjexxFCL::FArray1D< T >::dimension(), ObjexxFCL::KeyFArray1D< T >::dimension(), ObjexxFCL::KeyFArray2D< T >::dimension_assign(), ObjexxFCL::FArray2D< T >::dimension_assign(), ObjexxFCL::KeyFArray3D< T >::dimension_assign(), ObjexxFCL::FArray3D< T >::dimension_assign(), ObjexxFCL::KeyFArray4D< T >::dimension_assign(), ObjexxFCL::FArray4D< T >::dimension_assign(), ObjexxFCL::KeyFArray5D< T >::dimension_assign(), ObjexxFCL::FArray5D< T >::dimension_assign(), ObjexxFCL::FArray6D< T >::dimension_assign(), ObjexxFCL::KeyFArray6D< T >::dimension_assign(), ObjexxFCL::KeyFArray1D< T >::dimension_assign(), ObjexxFCL::FArray1D< T >::dimension_assign(), pyrosetta.bindings.pose.ResidueLabelAccessor::discard(), ObjexxFCL::FArray1D< T >::initializer_clear(), ObjexxFCL::FArray2D< T >::initializer_clear(), ObjexxFCL::FArray3D< T >::initializer_clear(), ObjexxFCL::FArray4D< T >::initializer_clear(), ObjexxFCL::FArray5D< T >::initializer_clear(), ObjexxFCL::FArray6D< T >::initializer_clear(), ObjexxFCL::KeyFArray1D< T >::initializer_clear(), ObjexxFCL::KeyFArray2D< T >::initializer_clear(), ObjexxFCL::KeyFArray3D< T >::initializer_clear(), ObjexxFCL::KeyFArray4D< T >::initializer_clear(), ObjexxFCL::KeyFArray5D< T >::initializer_clear(), and ObjexxFCL::KeyFArray6D< T >::initializer_clear().

function()

template<typename T , template< typename > class Array>

function_type const& ObjexxFCL::FArrayInitializer< T, Array >::function ( ) const

inline

Function.

References ObjexxFCL::FArrayInitializer< T, Array >::FUNCTION, ObjexxFCL::FArrayInitializer< T, Array >::function_, and ObjexxFCL::FArrayInitializer< T, Array >::state_.

Referenced by ObjexxFCL::FArray1D< T >::initialize(), ObjexxFCL::FArray2D< T >::initialize(), ObjexxFCL::FArray3D< T >::initialize(), ObjexxFCL::FArray4D< T >::initialize(), ObjexxFCL::FArray5D< T >::initialize(), ObjexxFCL::FArray6D< T >::initialize(), ObjexxFCL::KeyFArray1D< T >::initialize(), ObjexxFCL::KeyFArray2D< T >::initialize(), ObjexxFCL::KeyFArray3D< T >::initialize(), ObjexxFCL::KeyFArray4D< T >::initialize(), ObjexxFCL::KeyFArray5D< T >::initialize(), and ObjexxFCL::KeyFArray6D< T >::initialize().

is_active()

template<typename T , template< typename > class Array>

bool ObjexxFCL::FArrayInitializer< T, Array >::is_active ( ) const

inline

Active?

References ObjexxFCL::FArrayInitializer< T, Array >::INACTIVE, and ObjexxFCL::FArrayInitializer< T, Array >::state_.

Referenced by ObjexxFCL::FArray1D< T >::initialize(), ObjexxFCL::FArray2D< T >::initialize(), ObjexxFCL::FArray3D< T >::initialize(), ObjexxFCL::FArray4D< T >::initialize(), ObjexxFCL::FArray5D< T >::initialize(), ObjexxFCL::FArray6D< T >::initialize(), ObjexxFCL::KeyFArray1D< T >::initialize(), ObjexxFCL::KeyFArray2D< T >::initialize(), ObjexxFCL::KeyFArray3D< T >::initialize(), ObjexxFCL::KeyFArray4D< T >::initialize(), ObjexxFCL::KeyFArray5D< T >::initialize(), ObjexxFCL::KeyFArray6D< T >::initialize(), ObjexxFCL::FArray6D< T >::initializer_active(), ObjexxFCL::KeyFArray1D< T >::initializer_active(), ObjexxFCL::KeyFArray2D< T >::initializer_active(), ObjexxFCL::KeyFArray3D< T >::initializer_active(), ObjexxFCL::KeyFArray4D< T >::initializer_active(), ObjexxFCL::KeyFArray5D< T >::initializer_active(), ObjexxFCL::KeyFArray6D< T >::initializer_active(), ObjexxFCL::FArray1D< T >::initializer_active(), ObjexxFCL::FArray2D< T >::initializer_active(), ObjexxFCL::FArray3D< T >::initializer_active(), ObjexxFCL::FArray4D< T >::initializer_active(), and ObjexxFCL::FArray5D< T >::initializer_active().

is_function()

template<typename T , template< typename > class Array>

bool ObjexxFCL::FArrayInitializer< T, Array >::is_function ( ) const

inline

Function?

References ObjexxFCL::FArrayInitializer< T, Array >::FUNCTION, and ObjexxFCL::FArrayInitializer< T, Array >::state_.

Referenced by ObjexxFCL::FArray1D< T >::initialize(), ObjexxFCL::FArray2D< T >::initialize(), ObjexxFCL::FArray3D< T >::initialize(), ObjexxFCL::FArray4D< T >::initialize(), ObjexxFCL::FArray5D< T >::initialize(), ObjexxFCL::FArray6D< T >::initialize(), ObjexxFCL::KeyFArray1D< T >::initialize(), ObjexxFCL::KeyFArray2D< T >::initialize(), ObjexxFCL::KeyFArray3D< T >::initialize(), ObjexxFCL::KeyFArray4D< T >::initialize(), ObjexxFCL::KeyFArray5D< T >::initialize(), and ObjexxFCL::KeyFArray6D< T >::initialize().

is_value()

template<typename T , template< typename > class Array>

bool ObjexxFCL::FArrayInitializer< T, Array >::is_value ( ) const

inline

Value?

References ObjexxFCL::FArrayInitializer< T, Array >::state_, and ObjexxFCL::FArrayInitializer< T, Array >::VALUE.

Referenced by ObjexxFCL::FArray1D< T >::initialize(), ObjexxFCL::FArray2D< T >::initialize(), ObjexxFCL::FArray3D< T >::initialize(), ObjexxFCL::FArray4D< T >::initialize(), ObjexxFCL::FArray5D< T >::initialize(), ObjexxFCL::FArray6D< T >::initialize(), ObjexxFCL::KeyFArray1D< T >::initialize(), ObjexxFCL::KeyFArray2D< T >::initialize(), ObjexxFCL::KeyFArray3D< T >::initialize(), ObjexxFCL::KeyFArray4D< T >::initialize(), ObjexxFCL::KeyFArray5D< T >::initialize(), and ObjexxFCL::KeyFArray6D< T >::initialize().

operator=() [1/2]

template<typename T , template< typename > class Array>

FArrayInitializer& ObjexxFCL::FArrayInitializer< T, Array >::operator= ( function_type const &  function_a )

inline

Function Assignment.

References ObjexxFCL::FArrayInitializer< T, Array >::FUNCTION, ObjexxFCL::FArrayInitializer< T, Array >::function_, ObjexxFCL::FArrayInitializer< T, Array >::INACTIVE, ObjexxFCL::FArrayTraits< T >::initial_value(), ObjexxFCL::FArrayInitializer< T, Array >::state_, and ObjexxFCL::FArrayInitializer< T, Array >::value_.

operator=() [2/2]

template<typename T , template< typename > class Array>

FArrayInitializer& ObjexxFCL::FArrayInitializer< T, Array >::operator= ( T const &  value_a )

inline

Value Assignment.

References ObjexxFCL::FArrayInitializer< T, Array >::function_, ObjexxFCL::FArrayInitializer< T, Array >::state_, ObjexxFCL::FArrayInitializer< T, Array >::VALUE, and ObjexxFCL::FArrayInitializer< T, Array >::value_.

value()

template<typename T , template< typename > class Array>

T const& ObjexxFCL::FArrayInitializer< T, Array >::value ( ) const

inline

Value.

References ObjexxFCL::FArrayInitializer< T, Array >::state_, ObjexxFCL::FArrayInitializer< T, Array >::VALUE, and ObjexxFCL::FArrayInitializer< T, Array >::value_.

Referenced by ObjexxFCL::FArray1D< T >::initialize(), ObjexxFCL::FArray2D< T >::initialize(), ObjexxFCL::FArray3D< T >::initialize(), ObjexxFCL::FArray4D< T >::initialize(), ObjexxFCL::FArray5D< T >::initialize(), ObjexxFCL::FArray6D< T >::initialize(), ObjexxFCL::KeyFArray1D< T >::initialize(), ObjexxFCL::KeyFArray2D< T >::initialize(), ObjexxFCL::KeyFArray3D< T >::initialize(), ObjexxFCL::KeyFArray4D< T >::initialize(), ObjexxFCL::KeyFArray5D< T >::initialize(), and ObjexxFCL::KeyFArray6D< T >::initialize().

Member Data Documentation

function_

template<typename T , template< typename > class Array>

function_type ObjexxFCL::FArrayInitializer< T, Array >::function_

private

Function.

Referenced by ObjexxFCL::FArrayInitializer< T, Array >::clear(), ObjexxFCL::FArrayInitializer< T, Array >::function(), and ObjexxFCL::FArrayInitializer< T, Array >::operator=().

state_

template<typename T , template< typename > class Array>

State ObjexxFCL::FArrayInitializer< T, Array >::state_

private

State.

Referenced by ObjexxFCL::FArrayInitializer< T, Array >::clear(), ObjexxFCL::FArrayInitializer< T, Array >::function(), ObjexxFCL::FArrayInitializer< T, Array >::is_active(), ObjexxFCL::FArrayInitializer< T, Array >::is_function(), ObjexxFCL::FArrayInitializer< T, Array >::is_value(), ObjexxFCL::FArrayInitializer< T, Array >::operator=(), and ObjexxFCL::FArrayInitializer< T, Array >::value().

value_

template<typename T , template< typename > class Array>

T ObjexxFCL::FArrayInitializer< T, Array >::value_

private

Value.

Referenced by ObjexxFCL::FArrayInitializer< T, Array >::clear(), ObjexxFCL::FArrayInitializer< T, Array >::operator=(), and ObjexxFCL::FArrayInitializer< T, Array >::value().

---

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

• src/ObjexxFCL/FArrayInitializer.fwd.hh
• src/ObjexxFCL/FArrayInitializer.hh