Rosetta: numeric::IntervalSet< T > Class Template Reference

Rosetta

#include <IntervalSet.hh>

Public Member Functions
	IntervalSet ()

	IntervalSet (T start, T end)

	IntervalSet (T start1, T end1, T start2, T end2)

utility::vector0< T > const &	endpoints () const
	vector of interval set end points More...

void	clear ()
	clear the contents More...

void	set (T start, T end)
	set the inverval set to contain a single interval More...

void	set (T start1, T end1, T start2, T end2)
	set the interval set to contain two intervals More...

void	push_back (T start, T end)
	add an interval to the end of the set More...

T	length ()
	calculate the total length of all the intervals More...

bool	is_inside (T point)
	determine if a point is within one of the intervals More...

IntervalSet	operator& (IntervalSet const &right)
	calculate the intersection of two IntervalSets More...

T	random_point (random::RandomGenerator &RG)
	pick a random number uniformly from all the intervals More...

Private Attributes
utility::vector0< T >	endpoints_

Constructor & Destructor Documentation

◆ IntervalSet() [1/3]

template<typename T >

numeric::IntervalSet< T >::IntervalSet ( )

inline

◆ IntervalSet() [2/3]

template<typename T >

numeric::IntervalSet< T >::IntervalSet	(	T	start,
		T	end
	)

inline

References end, numeric::IntervalSet< T >::endpoints_, and basic::options::OptionKeys::cutoutdomain::start.

◆ IntervalSet() [3/3]

template<typename T >

numeric::IntervalSet< T >::IntervalSet	(	T	start1,
		T	end1,
		T	start2,
		T	end2
	)

inline

References numeric::IntervalSet< T >::endpoints_.

Member Function Documentation

◆ clear()

template<typename T >

void numeric::IntervalSet< T >::clear ( )

inline

clear the contents

References numeric::IntervalSet< T >::endpoints_.

Referenced by pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ endpoints()

template<typename T >

utility::vector0<T> const& numeric::IntervalSet< T >::endpoints ( ) const

inline

vector of interval set end points

References numeric::IntervalSet< T >::endpoints_.

◆ is_inside()

template<typename T >

bool numeric::IntervalSet< T >::is_inside ( T point )

inline

determine if a point is within one of the intervals

References numeric::IntervalSet< T >::endpoints_, create_a3b_hbs::i, and subloop_histogram::size.

◆ length()

template<typename T >

T numeric::IntervalSet< T >::length ( )

inline

calculate the total length of all the intervals

References numeric::IntervalSet< T >::endpoints_, create_a3b_hbs::i, ObjexxFCL::len(), and subloop_histogram::size.

Referenced by enumerate_junctions.Design::attach_valid(), enumerate_junctions.Design::output_string(), enumerate_junctions.Design::output_valid(), enumerate_junctions.DHR::print(), enumerate_junctions.Junction::print(), numeric::IntervalSet< T >::random_point(), enumerate_junctions.Junction::to_component(), enumerate_junctions.DHR::write_to_file(), and enumerate_junctions.Junction::write_to_file().

◆ operator&()

template<typename T >

IntervalSet numeric::IntervalSet< T >::operator& ( IntervalSet< T > const & right )

inline

calculate the intersection of two IntervalSets

Parameters

[in] right - the second Interval set

Returns: a new IntervalSet

References numeric::IntervalSet< T >::endpoints_, numeric::IntervalSet< T >::push_back(), and basic::options::OptionKeys::ufv::right.

◆ push_back()

template<typename T >

void numeric::IntervalSet< T >::push_back	(	T	start,
		T	end
	)

inline

add an interval to the end of the set

References end, numeric::IntervalSet< T >::endpoints_, subloop_histogram::size, and basic::options::OptionKeys::cutoutdomain::start.

Referenced by numeric::IntervalSet< T >::operator&().

◆ random_point()

template<typename T >

T numeric::IntervalSet< T >::random_point ( random::RandomGenerator & RG )

inline

pick a random number uniformly from all the intervals

Parameters

[in] RG - random number generator to use

Returns: random number

References numeric::IntervalSet< T >::endpoints_, create_a3b_hbs::i, create_a3b_hbs::j, ObjexxFCL::len(), numeric::IntervalSet< T >::length(), numeric::random::RandomGenerator::random_range(), RG, subloop_histogram::size, and numeric::random::RandomGenerator::uniform().

◆ set() [1/2]

template<typename T >

void numeric::IntervalSet< T >::set	(	T	start,
		T	end
	)

inline

set the inverval set to contain a single interval

References end, numeric::IntervalSet< T >::endpoints_, and basic::options::OptionKeys::cutoutdomain::start.

◆ set() [2/2]

template<typename T >

void numeric::IntervalSet< T >::set	(	T	start1,
		T	end1,
		T	start2,
		T	end2
	)

inline

set the interval set to contain two intervals

References numeric::IntervalSet< T >::endpoints_.

Member Data Documentation

◆ endpoints_

template<typename T >

utility::vector0<T> numeric::IntervalSet< T >::endpoints_

private

Referenced by numeric::IntervalSet< T >::clear(), numeric::IntervalSet< T >::endpoints(), numeric::IntervalSet< T >::IntervalSet(), numeric::IntervalSet< T >::is_inside(), numeric::IntervalSet< T >::length(), numeric::IntervalSet< T >::operator&(), numeric::IntervalSet< T >::push_back(), numeric::IntervalSet< T >::random_point(), and numeric::IntervalSet< T >::set().

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

src/numeric/IntervalSet.fwd.hh
src/numeric/IntervalSet.hh