Public Types | Public Member Functions | Static Public Member Functions
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< AminoAcidSetCreateCompleteSet ()
static std::vector< AminoAcidSetCreateThreeStateSet ()
static std::vector< AminoAcidSetCreatePseudoSet ()

Detailed Description

Amino acid bit set.

Definition at line 103 of file amino_acids.hh.

Member Typedef Documentation

◆ Iterator

Definition at line 105 of file amino_acids.hh.

Constructor & Destructor Documentation

◆ AminoAcidSet()

Member Function Documentation

◆ Add()

void Add ( AminoAcid  amino_acid)

add another amino acid

◆ Begin()

Iterator Begin ( ) const

iterator pointing to the beginning of the amino acid set

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.

◆ Contains()

bool Contains ( AminoAcid  amino_acid) const

whether the set contains a given amino acid

◆ CreateApolarSet()

static AminoAcidSet CreateApolarSet ( )

◆ CreateAromaticSet()

static AminoAcidSet CreateAromaticSet ( )

◆ CreateCompleteSet()

static std::vector<AminoAcidSet> CreateCompleteSet ( )

◆ CreatePolarSet()

static AminoAcidSet CreatePolarSet ( )

◆ CreatePseudoSet()

static std::vector<AminoAcidSet> CreatePseudoSet ( )

◆ CreateSet()

static AminoAcidSet CreateSet ( AminoAcid  aa)

◆ CreateThreeStateSet()

static std::vector<AminoAcidSet> CreateThreeStateSet ( )

◆ Empty()

bool Empty ( ) const

whether the set is empty

◆ End()

Iterator End ( ) const

iterator pointing to the end of the amino acids.

◆ operator!=()

bool operator!= ( const AminoAcidSet rhs) const

◆ operator==()

bool operator== ( const AminoAcidSet rhs) const

◆ Remove()

void Remove ( AminoAcid  amino_acid)

◆ Serialize()

void Serialize ( DS &  ds)

Definition at line 152 of file amino_acids.hh.

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