core::fragment::picking_old::vall::scores::VallFragmentScore Struct Reference

the base Vall FragmentScore struct More...

#include <VallFragmentScore.hh>

Public Types
typedef core::Real	Real
typedef VallSection::PageConstIterator	PageConstIterator
	typedef for Bookmark concept More...
typedef PageConstIterator	VallResidueConstIterator

Public Member Functions
	VallFragmentScore ()
	default constructor More...
	VallFragmentScore (VallFragmentScore const &rval)
	copy constructor More...
virtual	~VallFragmentScore ()
	default destructor More...
VallFragmentScore &	operator= (VallFragmentScore const &rval)
	copy assignment More...
bool	operator< (VallFragmentScore const &rval) const
	'<' comparison More...
virtual std::string	to_string () const
	return string describing contents or status More...
Size	distance () const
	compute distance (effectively the length of the extent) from begin -> end More...

Public Attributes
VallResidueConstIterator	extent_begin
	points to the beginning of the fragment More...
VallResidueConstIterator	extent_end
	points just beyond the end of the fragment More...
Real	score
	the cumulative score More...

Friends
std::ostream &	operator<< (std::ostream &o, VallFragmentScore const &s)
	friend declaration for stream operator << using virtual friend idiom More...

Detailed Description

the base Vall FragmentScore struct

Member Typedef Documentation

PageConstIterator

typedef VallSection::PageConstIterator core::fragment::picking_old::vall::scores::VallFragmentScore::PageConstIterator

typedef for Bookmark concept

Real

typedef core::Real core::fragment::picking_old::vall::scores::VallFragmentScore::Real

VallResidueConstIterator

typedef PageConstIterator core::fragment::picking_old::vall::scores::VallFragmentScore::VallResidueConstIterator

Constructor & Destructor Documentation

VallFragmentScore() [1/2]

core::fragment::picking_old::vall::scores::VallFragmentScore::VallFragmentScore ( )

inline

default constructor

VallFragmentScore() [2/2]

core::fragment::picking_old::vall::scores::VallFragmentScore::VallFragmentScore ( VallFragmentScore const &  rval )

inline

copy constructor

~VallFragmentScore()

virtual core::fragment::picking_old::vall::scores::VallFragmentScore::~VallFragmentScore ( )

inlinevirtual

default destructor

Member Function Documentation

distance()

Size core::fragment::picking_old::vall::scores::VallFragmentScore::distance ( ) const

inline

compute distance (effectively the length of the extent) from begin -> end

References core::kinematics::distance(), extent_begin, and extent_end.

operator<()

bool core::fragment::picking_old::vall::scores::VallFragmentScore::operator< ( VallFragmentScore const &  rval ) const

inline

'<' comparison

References score.

operator=()

VallFragmentScore& core::fragment::picking_old::vall::scores::VallFragmentScore::operator= ( VallFragmentScore const &  rval )

inline

copy assignment

References extent_begin, extent_end, and score.

to_string()

virtual std::string core::fragment::picking_old::vall::scores::VallFragmentScore::to_string ( ) const

inlinevirtual

return string describing contents or status

Remarks

overriding this will automatically give useable stream output due to friend operator << in base class

References score.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  o, VallFragmentScore const &  s  )

friend

friend declaration for stream operator << using virtual friend idiom

Remarks

uses virtual friend idiom, calls to_string()

Member Data Documentation

extent_begin

VallResidueConstIterator core::fragment::picking_old::vall::scores::VallFragmentScore::extent_begin

points to the beginning of the fragment

Referenced by distance(), core::fragment::picking_old::vall::eval::VallFragmentEval::operator()(), and operator=().

extent_end

VallResidueConstIterator core::fragment::picking_old::vall::scores::VallFragmentScore::extent_end

points just beyond the end of the fragment

Referenced by distance(), core::fragment::picking_old::vall::eval::VallFragmentEval::operator()(), and operator=().

score

Real core::fragment::picking_old::vall::scores::VallFragmentScore::score

the cumulative score

Referenced by core::fragment::picking_old::vall::eval::ABEGOEval::eval_impl(), core::fragment::picking_old::vall::eval::EnergyEval::eval_impl(), core::fragment::picking_old::vall::eval::IdentityEval::eval_impl(), operator<(), operator=(), and to_string().

---

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

• src/core/fragment/picking_old/vall/scores/VallFragmentScore.hh