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

#include <AtomID_Map.hh>

Public Member Functions
	AtomID_Map ()
	Default constructor with no arguments (PyRosetta workaround) More...

	AtomID_Map (Value const &default_value_a)
	Default constructor. More...

	AtomID_Map (Size const n_res)
	Number of residues constructor. More...

	AtomID_Map (Size const n_res, Value const &default_value_a)
	Number of residues constructor. More...

	~AtomID_Map ()
	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	fill ()
	Fill the map with the default fill value. More...

void	fill_with (Value const &value)
	Fill the map with a specified fill value. More...

void	fill_with (Size const seqpos, Value const &value)
	Fill the map at position seqpos with a specified fill value. More...

ConstReference	get (AtomID const &id) const
	Get the value for an AtomID: Extend the map if necessary, filling with the default value Phil changing this to be a non-resizing function. More...

void	set (AtomID const &id, Value const &value)
	Set the value for an AtomID: Extend the map if necessary, filling with the default value. More...

void	finalize ()
	Finalize after sizing all the vectors. More...

void	shrink ()
	Shrink the vectors to remove unused capacity. More...

void	swap (AtomID_Map &s)
	swap( AtomID_Map ) More...

void	clear ()
	Clear the map. More...

void	clear (Value const &default_value_a)
	Clear the map and set a new default value. More...

void	update_sequence_numbering (Size const new_size, utility::vector1< Size > const &old2new)

Size	size () const
	Size. More...

Size	n_residue () const
	Number of residues (size) 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 () const
	Default value. More...

void	default_value (Value const &default_value_a)
	Set default value. More...

bool	has (AtomID const &id) const
	Is an element with this AtomID present? More...

ConstReference	operator[] (AtomID const &id) const
	AtomID_Map[ atom_id ] const. More...

Reference	operator[] (AtomID const &id)
	AtomID_Map[ atom_id ]. More...

ConstReference	operator() (AtomID const &id) const
	AtomID_Map( atom_id ) const. More...

Reference	operator() (AtomID const &id)
	AtomID_Map( atom_id ) More...

ConstReference	operator() (Size const i_res, Size const i_atom) const
	AtomID_Map( i_res, i_atom ) const. More...

Reference	operator() (Size const i_res, Size const i_atom)
	AtomID_Map( i_res, i_atom ) More...

AtomMap const &	operator[] (Size const i_res) const
	AtomID_Map[ i_res ] const. More...

AtomMap &	operator[] (Size const i_res)
	AtomID_Map[ i_res ]. More...

AtomMap const &	operator() (Size const i_res) const
	AtomID_Map( i_res ) const. More...

AtomMap &	operator() (Size const i_res)
	AtomID_Map( i_res ) More...

Private Attributes
Value	default_value_
	Default value. More...

ResidueMap	res_map_
	Map from Atom identifiers to values. More...

Friends
template<typename TF >
void	swap (AtomID_Map< TF > &a, AtomID_Map< TF > &b)
	swap( AtomID_Map, AtomID_Map ) More...

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

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

Detailed Description

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

Map from Atom identifiers to contained values class.

Member Typedef Documentation

template<typename T>

typedef utility::vector1< T > core::id::AtomID_Map< T >::AtomMap

template<typename T>

typedef AtomMap::const_reference core::id::AtomID_Map< T >::const_reference

template<typename T>

typedef AtomMap::ConstReference core::id::AtomID_Map< T >::ConstReference

template<typename T>

typedef AtomMap::reference core::id::AtomID_Map< T >::reference

template<typename T>

typedef AtomMap::Reference core::id::AtomID_Map< T >::Reference

template<typename T>

typedef utility::vector1< AtomMap > core::id::AtomID_Map< T >::ResidueMap

template<typename T>

typedef platform::Size core::id::AtomID_Map< T >::Size

template<typename T>

typedef AtomMap::size_type core::id::AtomID_Map< T >::size_type

template<typename T>

typedef T core::id::AtomID_Map< T >::Value

template<typename T>

typedef T core::id::AtomID_Map< T >::value_type

Constructor & Destructor Documentation

template<typename T>

core::id::AtomID_Map< T >::AtomID_Map ( )

inlineexplicit

Default constructor with no arguments (PyRosetta workaround)

template<typename T>

core::id::AtomID_Map< T >::AtomID_Map ( Value const & default_value_a )

inlineexplicit

Default constructor.

template<typename T>

core::id::AtomID_Map< T >::AtomID_Map ( Size const n_res )

inlineexplicit

Number of residues constructor.

template<typename T>

core::id::AtomID_Map< T >::AtomID_Map	(	Size const	n_res,
		Value const &	default_value_a
	)

inlineexplicit

Number of residues constructor.

template<typename T>

core::id::AtomID_Map< T >::~AtomID_Map ( )

inline

Destructor.

Member Function Documentation

template<typename T>

void core::id::AtomID_Map< T >::clear ( )

inline

Clear the map.

Referenced by core::conformation::build_tree(), core::scoring::calc_per_atom_sasa(), core::scoring::calc_per_atom_sasa_sc(), core::scoring::calc_per_res_hydrophobic_sasa(), core::scoring::sasa::LeGrandSasa::calculate(), core::conformation::Conformation::clear(), core::kinematics::AtomTree::clear(), core::scoring::sasa::SasaCalc::init(), core::pose::initialize_atomid_map(), core::pose::initialize_atomid_map_heavy_only(), core::conformation::Conformation::insert_conformation_by_jump(), core::pose::metrics::simple_calculators::InterfaceSasaDefinitionCalculator::recompute(), and core::kinematics::AtomTree::replace_residue_subtree().

template<typename T>

void core::id::AtomID_Map< T >::clear ( Value const & default_value_a )

inline

Clear the map and set a new default value.

template<typename T>

Value const& core::id::AtomID_Map< T >::default_value ( ) const

inline

Default value.

template<typename T>

void core::id::AtomID_Map< T >::default_value ( Value const & default_value_a )

inline

Set default value.

template<typename T>

bool core::id::AtomID_Map< T >::empty ( ) const

inline

Empty?

template<typename T>

void core::id::AtomID_Map< T >::fill ( )

inline

Fill the map with the default fill value.

template<typename T>

void core::id::AtomID_Map< T >::fill_with ( Value const & value )

inline

Fill the map with a specified fill value.

Referenced by core::conformation::Conformation::reset_move_data().

template<typename T>

void core::id::AtomID_Map< T >::fill_with	(	Size const	seqpos,
		Value const &	value
	)

inline

Fill the map at position seqpos with a specified fill value.

template<typename T>

void core::id::AtomID_Map< T >::finalize ( )

inline

Finalize after sizing all the vectors.

template<typename T>

ConstReference core::id::AtomID_Map< T >::get ( AtomID const & id ) const

inline

Get the value for an AtomID: Extend the map if necessary, filling with the default value Phil changing this to be a non-resizing function.

Referenced by core::pack::figure_out_repackable_residues(), core::scoring::methods::ResidualDipolarCouplingEnergy::setup_for_minimizing(), core::scoring::methods::DipolarCouplingEnergy::setup_for_minimizing(), and core::scoring::methods::ChemicalShiftAnisotropyEnergy::setup_for_minimizing().

template<typename T>

bool core::id::AtomID_Map< T >::has ( AtomID const & id ) const

inline

Is an element with this AtomID present?

Referenced by core::optimization::CartesianMinimizerMap::assign_rosetta_torsions_and_trim(), core::scoring::methods::ResidualDipolarCouplingEnergy::eval_atom_derivative(), core::scoring::methods::DipolarCouplingEnergy::eval_atom_derivative(), core::scoring::methods::ChemicalShiftAnisotropyEnergy::eval_atom_derivative(), core::scoring::methods::ResidualDipolarCouplingEnergyRigidSegments::eval_atom_derivative(), and core::kinematics::AtomTree::has().

template<typename T>

Size core::id::AtomID_Map< T >::n_atom ( Size const i_res ) const

inline

Number of atoms in a residue.

Referenced by core::scoring::calc_per_atom_sasa_sc(), and core::scoring::packing::initialize_AtomID_Map().

template<typename T>

Size core::id::AtomID_Map< T >::n_residue ( ) const

inline

Number of residues (size)

Referenced by core::scoring::calc_per_atom_sasa_sc(), core::scoring::sasa::get_sc_bb_sasa(), and core::scoring::sasa::get_sc_bb_sasa_per_res().

template<typename T>

ConstReference core::id::AtomID_Map< T >::operator() ( AtomID const & id ) const

inline

AtomID_Map( atom_id ) const.

template<typename T>

Reference core::id::AtomID_Map< T >::operator() ( AtomID const & id )

inline

AtomID_Map( atom_id )

template<typename T>

ConstReference core::id::AtomID_Map< T >::operator()	(	Size const	i_res,
		Size const	i_atom
	)		const

inline

AtomID_Map( i_res, i_atom ) const.

template<typename T>

Reference core::id::AtomID_Map< T >::operator()	(	Size const	i_res,
		Size const	i_atom
	)

inline

AtomID_Map( i_res, i_atom )

template<typename T>

AtomMap const& core::id::AtomID_Map< T >::operator() ( Size const i_res ) const

inline

AtomID_Map( i_res ) const.

template<typename T>

AtomMap& core::id::AtomID_Map< T >::operator() ( Size const i_res )

inline

AtomID_Map( i_res )

template<typename T>

ConstReference core::id::AtomID_Map< T >::operator[] ( AtomID const & id ) const

inline

AtomID_Map[ atom_id ] const.

template<typename T>

Reference core::id::AtomID_Map< T >::operator[] ( AtomID const & id )

inline

AtomID_Map[ atom_id ].

template<typename T>

AtomMap const& core::id::AtomID_Map< T >::operator[] ( Size const i_res ) const

inline

AtomID_Map[ i_res ] const.

template<typename T>

AtomMap& core::id::AtomID_Map< T >::operator[] ( Size const i_res )

inline

AtomID_Map[ i_res ].

template<typename T>

void core::id::AtomID_Map< T >::resize ( Size const n_res )

inline

Resize to a given number of residues.

Referenced by core::conformation::build_tree(), core::scoring::calc_per_res_hydrophobic_sasa(), core::pack::interaction_graph::SurfacePotential::compute_pose_hpatch_score(), core::kinematics::AtomTree::delete_seqpos(), core::scoring::packing::initialize_AtomID_Map(), core::pose::initialize_atomid_map(), core::pose::initialize_atomid_map_heavy_only(), core::conformation::Conformation::insert_conformation_by_jump(), core::pack::scmin::ResidueAtomTreeCollection::ResidueAtomTreeCollection(), and core::conformation::Conformation::residues_append().

template<typename T>

void core::id::AtomID_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::AtomID_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::AtomID_Map< T >::set	(	AtomID const &	id,
		Value const &	value
	)

inline

Set the value for an AtomID: Extend the map if necessary, filling with the default value.

Referenced by core::sequence::calpha_superimpose_with_mapping(), core::scoring::packing::compute_holes_deriv(), core::scoring::packing::compute_holes_score(), core::scoring::packing::compute_rosettaholes_score(), core::pose::convert_from_std_map(), core::conformation::setup_corresponding_atoms(), core::scoring::methods::ResidualDipolarCouplingEnergy::setup_for_minimizing(), core::scoring::methods::ChemicalShiftAnisotropyEnergy::setup_for_minimizing(), core::scoring::methods::DipolarCouplingEnergy::setup_for_minimizing(), and core::scoring::methods::ResidualDipolarCouplingEnergyRigidSegments::setup_for_minimizing().

template<typename T>

void core::id::AtomID_Map< T >::shrink ( )

inline

Shrink the vectors to remove unused capacity.

Referenced by core::id::AtomID_Map< core::Size >::finalize().

template<typename T>

Size core::id::AtomID_Map< T >::size ( ) const

inline

Size.

Referenced by core::conformation::Conformation::append_polymer_residue_after_seqpos(), core::kinematics::AtomTree::AtomTree(), core::kinematics::AtomTree::find_root_from_atom_pointer(), core::scoring::packing::initialize_AtomID_Map(), core::conformation::Conformation::prepend_polymer_residue_before_seqpos(), core::kinematics::AtomTree::replace_tree(), core::kinematics::AtomTree::size(), core::kinematics::AtomTree::update_atom_ids_from_atom_pointer(), and core::id::AtomID_Map< core::Size >::update_sequence_numbering().

template<typename T>

void core::id::AtomID_Map< T >::swap ( AtomID_Map< T > & s )

inline

swap( AtomID_Map )

Referenced by core::id::AtomID_Map< core::Size >::update_sequence_numbering().

template<typename T>

void core::id::AtomID_Map< T >::update_sequence_numbering	(	Size const	new_size,
		utility::vector1< Size > const &	old2new
	)

inline

Should move to .cc? if old2new[pos] == 0 , that position's mapping is lost if old2new[1...old_size] doesnt cover all of [1...new_size], the missed positions will have res_map_[pos].empty()

Referenced by core::kinematics::AtomTree::update_sequence_numbering(), and core::conformation::Conformation::update_sequence_numbering().

Friends And Related Function Documentation

template<typename T>

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

friend

AtomID_Map != AtomID_Map.

template<typename T>

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

friend

AtomID_Map == AtomID_Map.

template<typename T>

template<typename TF >

void swap	(	AtomID_Map< TF > &	a,
		AtomID_Map< TF > &	b
	)

friend

swap( AtomID_Map, AtomID_Map )

Member Data Documentation

template<typename T>

Value core::id::AtomID_Map< T >::default_value_

private

Default value.

Referenced by core::id::AtomID_Map< core::Size >::clear(), core::id::AtomID_Map< core::Size >::default_value(), core::id::AtomID_Map< core::Size >::fill(), core::id::AtomID_Map< core::Size >::get(), core::id::AtomID_Map< core::Size >::resize(), core::id::AtomID_Map< core::Size >::set(), and core::id::AtomID_Map< core::Size >::update_sequence_numbering().

template<typename T>

ResidueMap core::id::AtomID_Map< T >::res_map_

private

Map from Atom identifiers to values.

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

symlinks/rosetta/src/core/id/AtomID_Map.fwd.hh
symlinks/rosetta/src/core/id/AtomID_Map.hh

Public Types
typedef utility::vector1< T >	AtomMap

typedef utility::vector1< AtomMap >	ResidueMap

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 Types

Public Member Functions

Private Attributes

Friends

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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