AminoAcidSet Class Reference

#include <amino_acids.hh>

Public Types
typedef AminoAcidSetIterator	Iterator

Public Member Functions
	AminoAcidSet ()
void	Add (AminoAcid amino_acid)
void	Remove (AminoAcid amino_acid)
bool	Contains (AminoAcid amino_acid) const
bool	Empty () const
Iterator	Begin () const
Iterator	End () const
bool	operator== (const AminoAcidSet &rhs) const
bool	operator!= (const AminoAcidSet &rhs) const
template<typename DS >
void	Serialize (DS &ds)

Static Public Member Functions
static AminoAcidSet	CreatePolarSet ()
static AminoAcidSet	CreateAromaticSet ()
static AminoAcidSet	CreateApolarSet ()
static AminoAcidSet	CreateSet (AminoAcid aa)
static std::vector< AminoAcidSet >	CreateCompleteSet ()
static std::vector< AminoAcidSet >	CreateThreeStateSet ()
static std::vector< AminoAcidSet >	CreatePseudoSet ()

---

Detailed Description

Amino acid bit set.

Definition at line 98 of file amino_acids.hh.

---

Member Typedef Documentation

typedef AminoAcidSetIterator Iterator

Definition at line 100 of file amino_acids.hh.

---

Constructor & Destructor Documentation

AminoAcidSet

(

)

---

Member Function Documentation

void Add

(

AminoAcid

amino_acid

)

add another amino acid

Iterator Begin

(

)

const

iterator pointing to the beginning of the amino acid set

 @code 

for (AminoAcidSet::iterator i=aa_set.Begin(), e=aa_set.End(); i!=e; ++i) { . . . } will iterate over all the amino acids present in the set.

bool Contains

(

AminoAcid

amino_acid

)

const

whether the set contains a given amino acid

static AminoAcidSet CreateApolarSet ( )

static

static AminoAcidSet CreateAromaticSet ( )

static

static std::vector<AminoAcidSet> CreateCompleteSet ( )

static

static AminoAcidSet CreatePolarSet ( )

static

static std::vector<AminoAcidSet> CreatePseudoSet ( )

static

static AminoAcidSet CreateSet ( AminoAcid  aa )

static

static std::vector<AminoAcidSet> CreateThreeStateSet ( )

static

bool Empty

(

)

const

whether the set is empty

Iterator End

(

)

const

iterator pointing to the end of the amino acids.

bool operator!=

(

const AminoAcidSet &

rhs

)

const

bool operator==

(

const AminoAcidSet &

rhs

)

const

void Remove

(

AminoAcid

amino_acid

)

void Serialize ( DS &  ds )

inline

Definition at line 147 of file amino_acids.hh.

---

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

• stage/include/ost/qa/amino_acids.hh