Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
core::id::DOF_ID_Map< T > Class Template Reference

Map from Atom DOF identifiers to contained values class. More...

#include <DOF_ID_Map.hh>

Public Types

typedef AtomID_Map< T > AtomMap
 
typedef utility::vector1< AtomMapDOF_Map
 
typedef T value_type
 
typedef AtomMap::reference reference
 
typedef AtomMap::const_reference const_reference
 
typedef AtomMap::size_type size_type
 
typedef T Value
 
typedef AtomMap::Reference Reference
 
typedef AtomMap::ConstReference ConstReference
 
typedef platform::Size Size
 

Public Member Functions

 DOF_ID_Map (Value const &default_value_a=Value())
 Default constructor. More...
 
 DOF_ID_Map (Size const n_res, Value const &default_value_a=Value())
 Number of residues constructor. More...
 
 ~DOF_ID_Map ()=default
 Destructor. More...
 
void resize (Size const n_res)
 Resize to a given number of residues. More...
 
void resize (Size const i_res, Size const n_atom)
 Resize the number of atoms of a residue and use the default fill value. More...
 
void resize (Size const i_res, Size const n_atom, Value const &value)
 Resize the number of atoms of a residue and use a specified fill value. More...
 
void finalize ()
 Finalize after sizing all the vectors. More...
 
void shrink ()
 Shrink the vectors to remove unused capacity. More...
 
void swap (DOF_ID_Map &s)
 swap( DOF_ID_Map ) More...
 
void clear ()
 Clear the vectors. More...
 
void set (DOF_Type const dof)
 Set a DOF for all atoms to the default value for that DOF. More...
 
void set (DOF_Type const dof, Value const &value)
 Set a DOF for all atoms to a specified value. More...
 
Size size () const
 Size (Number of DOF types) More...
 
Size n_residue () const
 Number of residues. More...
 
Size n_atom (Size const i_res) const
 Number of atoms in a residue. More...
 
bool empty () const
 Empty? More...
 
Value const & default_value (DOF_Type const dof) const
 Default value for a DOF. More...
 
void default_value (DOF_Type const dof, Value const &default_value_a)
 Set default value for a DOF. More...
 
void default_value (Value const &default_value_a)
 Set a uniform default value. More...
 
ConstReference operator[] (DOF_ID const &id) const
 DOF_ID_Map[ dof_id ] const. More...
 
Reference operator[] (DOF_ID const &id)
 DOF_ID_Map[ dof_id ]. More...
 
ConstReference operator() (DOF_ID const &id) const
 DOF_ID_Map( dof_id ) const. More...
 
Reference operator() (DOF_ID const &id)
 DOF_ID_Map( dof_id ) More...
 
ConstReference operator() (Size const i_res, Size const i_atom, DOF_Type const dof) const
 DOF_ID_Map( i_res, i_atom ) const. More...
 
Reference operator() (Size const i_res, Size const i_atom, DOF_Type const dof)
 DOF_ID_Map( i_res, i_atom ) More...
 
AtomMap const & operator[] (DOF_Type const dof) const
 DOF_ID_Map[ dof ] const. More...
 
AtomMapoperator[] (DOF_Type const dof)
 DOF_ID_Map[ dof ]. More...
 
AtomMap const & operator() (DOF_Type const dof) const
 DOF_ID_Map( dof ) const. More...
 
AtomMapoperator() (DOF_Type const dof)
 DOF_ID_Map( dof ) More...
 

Private Attributes

DOF_Map dof_map_
 Map from Atom DOF identifiers to values. More...
 

Friends

void swap (DOF_ID_Map &a, DOF_ID_Map &b)
 swap( DOF_ID_Map, DOF_ID_Map ) More...
 
bool operator== (DOF_ID_Map const &a, DOF_ID_Map const &b)
 DOF_ID_Map == DOF_ID_Map. More...
 
bool operator!= (DOF_ID_Map const &a, DOF_ID_Map const &b)
 DOF_ID_Map != DOF_ID_Map. More...
 

Detailed Description

template<typename T>
class core::id::DOF_ID_Map< T >

Map from Atom DOF identifiers to contained values class.

Member Typedef Documentation

template<typename T>
typedef AtomID_Map< T > core::id::DOF_ID_Map< T >::AtomMap
template<typename T>
typedef AtomMap::ConstReference core::id::DOF_ID_Map< T >::ConstReference
template<typename T>
typedef utility::vector1< AtomMap > core::id::DOF_ID_Map< T >::DOF_Map
template<typename T>
typedef AtomMap::reference core::id::DOF_ID_Map< T >::reference
template<typename T>
typedef AtomMap::Reference core::id::DOF_ID_Map< T >::Reference
template<typename T>
typedef platform::Size core::id::DOF_ID_Map< T >::Size
template<typename T>
typedef AtomMap::size_type core::id::DOF_ID_Map< T >::size_type
template<typename T>
typedef T core::id::DOF_ID_Map< T >::Value
template<typename T>
typedef T core::id::DOF_ID_Map< T >::value_type

Constructor & Destructor Documentation

template<typename T>
core::id::DOF_ID_Map< T >::DOF_ID_Map ( Value const &  default_value_a = Value())
inlineexplicit

Default constructor.

template<typename T>
core::id::DOF_ID_Map< T >::DOF_ID_Map ( Size const  n_res,
Value const &  default_value_a = Value() 
)
inlineexplicit

Number of residues constructor.

template<typename T>
core::id::DOF_ID_Map< T >::~DOF_ID_Map ( )
inlinedefault

Destructor.

Member Function Documentation

template<typename T>
void core::id::DOF_ID_Map< T >::clear ( )
inline
template<typename T>
Value const& core::id::DOF_ID_Map< T >::default_value ( DOF_Type const  dof) const
inline

Default value for a DOF.

template<typename T>
void core::id::DOF_ID_Map< T >::default_value ( DOF_Type const  dof,
Value const &  default_value_a 
)
inline

Set default value for a DOF.

template<typename T>
void core::id::DOF_ID_Map< T >::default_value ( Value const &  default_value_a)
inline

Set a uniform default value.

template<typename T>
bool core::id::DOF_ID_Map< T >::empty ( ) const
inline

Empty?

template<typename T>
void core::id::DOF_ID_Map< T >::finalize ( )
inline

Finalize after sizing all the vectors.

template<typename T>
Size core::id::DOF_ID_Map< T >::n_atom ( Size const  i_res) const
inline

Number of atoms in a residue.

template<typename T>
Size core::id::DOF_ID_Map< T >::n_residue ( ) const
inline

Number of residues.

template<typename T>
ConstReference core::id::DOF_ID_Map< T >::operator() ( DOF_ID const &  id) const
inline

DOF_ID_Map( dof_id ) const.

template<typename T>
Reference core::id::DOF_ID_Map< T >::operator() ( DOF_ID const &  id)
inline

DOF_ID_Map( dof_id )

template<typename T>
ConstReference core::id::DOF_ID_Map< T >::operator() ( Size const  i_res,
Size const  i_atom,
DOF_Type const  dof 
) const
inline

DOF_ID_Map( i_res, i_atom ) const.

template<typename T>
Reference core::id::DOF_ID_Map< T >::operator() ( Size const  i_res,
Size const  i_atom,
DOF_Type const  dof 
)
inline

DOF_ID_Map( i_res, i_atom )

template<typename T>
AtomMap const& core::id::DOF_ID_Map< T >::operator() ( DOF_Type const  dof) const
inline

DOF_ID_Map( dof ) const.

template<typename T>
AtomMap& core::id::DOF_ID_Map< T >::operator() ( DOF_Type const  dof)
inline

DOF_ID_Map( dof )

template<typename T>
ConstReference core::id::DOF_ID_Map< T >::operator[] ( DOF_ID const &  id) const
inline

DOF_ID_Map[ dof_id ] const.

template<typename T>
Reference core::id::DOF_ID_Map< T >::operator[] ( DOF_ID const &  id)
inline

DOF_ID_Map[ dof_id ].

template<typename T>
AtomMap const& core::id::DOF_ID_Map< T >::operator[] ( DOF_Type const  dof) const
inline

DOF_ID_Map[ dof ] const.

template<typename T>
AtomMap& core::id::DOF_ID_Map< T >::operator[] ( DOF_Type const  dof)
inline

DOF_ID_Map[ dof ].

template<typename T>
void core::id::DOF_ID_Map< T >::resize ( Size const  n_res)
inline

Resize to a given number of residues.

Referenced by core::pose::initialize_dof_id_map().

template<typename T>
void core::id::DOF_ID_Map< T >::resize ( Size const  i_res,
Size const  n_atom 
)
inline

Resize the number of atoms of a residue and use the default fill value.

template<typename T>
void core::id::DOF_ID_Map< T >::resize ( Size const  i_res,
Size const  n_atom,
Value const &  value 
)
inline

Resize the number of atoms of a residue and use a specified fill value.

template<typename T>
void core::id::DOF_ID_Map< T >::set ( DOF_Type const  dof)
inline

Set a DOF for all atoms to the default value for that DOF.

template<typename T>
void core::id::DOF_ID_Map< T >::set ( DOF_Type const  dof,
Value const &  value 
)
inline

Set a DOF for all atoms to a specified value.

template<typename T>
void core::id::DOF_ID_Map< T >::shrink ( )
inline

Shrink the vectors to remove unused capacity.

Referenced by core::id::DOF_ID_Map< DOF_NodeOP >::finalize().

template<typename T>
Size core::id::DOF_ID_Map< T >::size ( ) const
inline

Size (Number of DOF types)

template<typename T>
void core::id::DOF_ID_Map< T >::swap ( DOF_ID_Map< T > &  s)
inline

swap( DOF_ID_Map )

Friends And Related Function Documentation

template<typename T>
bool operator!= ( DOF_ID_Map< T > const &  a,
DOF_ID_Map< T > const &  b 
)
friend
template<typename T>
bool operator== ( DOF_ID_Map< T > const &  a,
DOF_ID_Map< T > const &  b 
)
friend
template<typename T>
void swap ( DOF_ID_Map< T > &  a,
DOF_ID_Map< T > &  b 
)
friend

swap( DOF_ID_Map, DOF_ID_Map )

Member Data Documentation

template<typename T>
DOF_Map core::id::DOF_ID_Map< T >::dof_map_
private

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