Rosetta: core::fragment::CacheWrapper< T, XCacheUnit > Class Template Reference

Rosetta

#include <FragCache.hh>

Inheritance diagram for core::fragment::CacheWrapper< T, XCacheUnit >:

Inheritance graph

[legend]

Public Types
typedef utility::vector1< core::Size >	IndexList

typedef utility::vector1< core::Real >	ScoreList

typedef XCacheUnit	TCacheUnit

typedef utility::pointer::weak_ptr< TCacheUnit >	TCacheUnitAP

typedef utility::pointer::shared_ptr< TCacheUnit >	TCacheUnitOP

typedef std::pair< FragID, T >	ScoredFrag

typedef utility::vector1< ScoredFrag >	ScoredList

Public Member Functions
	CacheWrapper (std::string const &tag)

	~CacheWrapper ()=default

bool	retrieve (Frame const &frame, core::Size frag_num, T &score) const

bool	retrieve (FragID const &frag_id, T &score) const

T	retrieve (core::Size frag_id) const

T	retrieve (FragID const &frag_id) const

T	retrieve (Frame const &frame, core::Size frag_num) const

void	store (Frame const &frame, core::Size frag_num, T const &score)

void	store (FragID const &frag_id, T const &score)

void	scored_frag_ids (ScoredList &frag_ids, FragID_Iterator begin, FragID_Iterator end, T *empty=NULL) const

void	scored_frag_ids (ScoredList &frag_ids, FragID_Iterator begin, FragID_Iterator end, T empty) const

TCacheUnit const &	cache (Frame const &frame) const

TCacheUnit &	cache (Frame const &frame)

TCacheUnit &	operator() (Frame const &frame)

Public Attributes
std::string	tag_

TCacheUnitOP	new_cache_

Member Typedef Documentation

◆ IndexList

template<class T , class XCacheUnit >

typedef utility::vector1< core::Size > core::fragment::CacheWrapper< T, XCacheUnit >::IndexList

◆ ScoredFrag

template<class T , class XCacheUnit >

typedef std::pair< FragID, T > core::fragment::CacheWrapper< T, XCacheUnit >::ScoredFrag

◆ ScoredList

template<class T , class XCacheUnit >

typedef utility::vector1< ScoredFrag> core::fragment::CacheWrapper< T, XCacheUnit >::ScoredList

◆ ScoreList

template<class T , class XCacheUnit >

typedef utility::vector1< core::Real > core::fragment::CacheWrapper< T, XCacheUnit >::ScoreList

◆ TCacheUnit

template<class T , class XCacheUnit >

typedef XCacheUnit core::fragment::CacheWrapper< T, XCacheUnit >::TCacheUnit

◆ TCacheUnitAP

template<class T , class XCacheUnit >

typedef utility::pointer::weak_ptr< TCacheUnit > core::fragment::CacheWrapper< T, XCacheUnit >::TCacheUnitAP

◆ TCacheUnitOP

template<class T , class XCacheUnit >

typedef utility::pointer::shared_ptr< TCacheUnit > core::fragment::CacheWrapper< T, XCacheUnit >::TCacheUnitOP

Constructor & Destructor Documentation

◆ CacheWrapper()

template<class T , class XCacheUnit >

core::fragment::CacheWrapper< T, XCacheUnit >::CacheWrapper ( std::string const & tag )

inline

◆ ~CacheWrapper()

template<class T , class XCacheUnit >

core::fragment::CacheWrapper< T, XCacheUnit >::~CacheWrapper ( )

default

Member Function Documentation

◆ cache() [1/2]

template<class T , class XCacheUnit >

TCacheUnit& core::fragment::CacheWrapper< T, XCacheUnit >::cache ( Frame const & frame )

inline

References core::fragment::Frame::cache(), core::fragment::CacheWrapper< T, XCacheUnit >::new_cache_, and core::fragment::CacheWrapper< T, XCacheUnit >::tag_.

◆ cache() [2/2]

template<class T , class XCacheUnit >

TCacheUnit const& core::fragment::CacheWrapper< T, XCacheUnit >::cache ( Frame const & frame ) const

inline

References core::fragment::Frame::cache(), core::fragment::CacheWrapper< T, XCacheUnit >::new_cache_, and core::fragment::CacheWrapper< T, XCacheUnit >::tag_.

Referenced by core::fragment::CacheWrapper< T, XCacheUnit >::operator()(), core::fragment::CacheWrapper< T, XCacheUnit >::retrieve(), and core::fragment::CacheWrapper< T, XCacheUnit >::store().

◆ operator()()

template<class T , class XCacheUnit >

TCacheUnit& core::fragment::CacheWrapper< T, XCacheUnit >::operator() ( Frame const & frame )

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::cache().

◆ retrieve() [1/5]

template<class T , class XCacheUnit >

T core::fragment::CacheWrapper< T, XCacheUnit >::retrieve ( core::Size frag_id ) const

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::retrieve(), core::fragment::CacheWrapper< T, XCacheUnit >::tag_, and protocols::hybridization::val.

◆ retrieve() [2/5]

template<class T , class XCacheUnit >

T core::fragment::CacheWrapper< T, XCacheUnit >::retrieve ( FragID const & frag_id ) const

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::retrieve(), core::fragment::CacheWrapper< T, XCacheUnit >::tag_, and protocols::hybridization::val.

◆ retrieve() [3/5]

template<class T , class XCacheUnit >

bool core::fragment::CacheWrapper< T, XCacheUnit >::retrieve	(	FragID const &	frag_id,
		T &	score
	)		const

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::cache(), core::fragment::FragID::frame(), core::fragment::FragID::id(), and protocols::hybridization::score.

◆ retrieve() [4/5]

template<class T , class XCacheUnit >

T core::fragment::CacheWrapper< T, XCacheUnit >::retrieve	(	Frame const &	frame,
		core::Size	frag_num
	)		const

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::retrieve(), core::fragment::CacheWrapper< T, XCacheUnit >::tag_, and protocols::hybridization::val.

◆ retrieve() [5/5]

template<class T , class XCacheUnit >

bool core::fragment::CacheWrapper< T, XCacheUnit >::retrieve	(	Frame const &	frame,
		core::Size	frag_num,
		T &	score
	)		const

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::cache(), core::fragment::Frame::frag_id(), and protocols::hybridization::score.

Referenced by core::fragment::CacheWrapper< T, XCacheUnit >::retrieve(), core::fragment::CacheWrapper< T, XCacheUnit >::scored_frag_ids(), protocols::loops::loop_closure::ccd::SlidingWindowLoopClosure::select_final_loop(), and protocols::loops::loop_closure::ccd::FASelectSlidingWindowLoopClosure::select_final_loop().

◆ scored_frag_ids() [1/2]

template<class T , class XCacheUnit >

void core::fragment::CacheWrapper< T, XCacheUnit >::scored_frag_ids	(	ScoredList &	frag_ids,
		FragID_Iterator	begin,
		FragID_Iterator	end,
		T *	empty = `NULL`
	)		const

inline

References core::sequence::end, core::fragment::CacheWrapper< T, XCacheUnit >::retrieve(), and protocols::hybridization::score.

Referenced by core::fragment::CacheWrapper< T, XCacheUnit >::scored_frag_ids().

◆ scored_frag_ids() [2/2]

template<class T , class XCacheUnit >

void core::fragment::CacheWrapper< T, XCacheUnit >::scored_frag_ids	(	ScoredList &	frag_ids,
		FragID_Iterator	begin,
		FragID_Iterator	end,
		T	empty
	)		const

inline

References core::sequence::end, and core::fragment::CacheWrapper< T, XCacheUnit >::scored_frag_ids().

◆ store() [1/2]

template<class T , class XCacheUnit >

void core::fragment::CacheWrapper< T, XCacheUnit >::store	(	FragID const &	frag_id,
		T const &	score
	)

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::cache(), core::fragment::FragID::frame(), core::fragment::FragID::id(), and protocols::hybridization::score.

◆ store() [2/2]

template<class T , class XCacheUnit >

void core::fragment::CacheWrapper< T, XCacheUnit >::store	(	Frame const &	frame,
		core::Size	frag_num,
		T const &	score
	)

inline

References core::fragment::CacheWrapper< T, XCacheUnit >::cache(), core::fragment::Frame::frag_id(), and protocols::hybridization::score.

Referenced by protocols::loops::loop_closure::ccd::SlidingWindowLoopClosure::process_fragments(), and protocols::loops::loop_closure::ccd::FASelectSlidingWindowLoopClosure::select_final_loop().

Member Data Documentation

◆ new_cache_

template<class T , class XCacheUnit >

TCacheUnitOP core::fragment::CacheWrapper< T, XCacheUnit >::new_cache_

Referenced by core::fragment::CacheWrapper< T, XCacheUnit >::cache().

◆ tag_

template<class T , class XCacheUnit >

std::string core::fragment::CacheWrapper< T, XCacheUnit >::tag_

Referenced by core::fragment::CacheWrapper< T, XCacheUnit >::cache(), and core::fragment::CacheWrapper< T, XCacheUnit >::retrieve().

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

src/core/fragment/FragCache.hh