An inteface to handle decomposing of integer values/masses over a set of integer weights (alphabet). More...
#include <OpenMS/CHEMISTRY/MASSDECOMPOSITION/IMS/MassDecomposer.h>
Public Types | |
| typedef ValueType | value_type |
| typedef DecompositionValueType | decomposition_value_type |
| typedef std::vector < decomposition_value_type > | decomposition_type |
| typedef std::vector < decomposition_type > | decompositions_type |
Public Member Functions | |
| virtual | ~MassDecomposer () |
| virtual bool | exist (value_type mass)=0 |
| virtual decomposition_type | getDecomposition (value_type mass)=0 |
| virtual decompositions_type | getAllDecompositions (value_type mass)=0 |
| virtual decomposition_value_type | getNumberOfDecompositions (value_type mass)=0 |
Detailed Description
template<typename ValueType, typename DecompositionValueType>
class OpenMS::ims::MassDecomposer< ValueType, DecompositionValueType >
An inteface to handle decomposing of integer values/masses over a set of integer weights (alphabet).
An interface that addresses the following "mass decomposition" problems:
- Existence Problem (whether the decomposition of the given mass exists),
- One Decomposition Problem (returns one possible decomposition),
- All Decompositions Problem (returns all possible decompositions),
- Number of Decompositions Problem (returns the number of possible decompositions).
Those problems are solved in integer arithmetics, i.e. only exact solutions are found with no error allowed.
- Parameters:
-
ValueType Type of values to be decomposed. DecompositionValueType Type of decomposition elements.
Member Typedef Documentation
| typedef std::vector<decomposition_value_type> decomposition_type |
Type of decomposition container.
Reimplemented in IntegerMassDecomposer< ValueType, DecompositionValueType >.
| typedef DecompositionValueType decomposition_value_type |
Type of decomposition value.
Reimplemented in IntegerMassDecomposer< ValueType, DecompositionValueType >.
| typedef std::vector<decomposition_type> decompositions_type |
Type of container for many decompositions.
Reimplemented in IntegerMassDecomposer< ValueType, DecompositionValueType >.
| typedef ValueType value_type |
Type of value to be decomposed.
Reimplemented in IntegerMassDecomposer< ValueType, DecompositionValueType >.
Constructor & Destructor Documentation
| virtual ~MassDecomposer | ( | ) | [inline, virtual] |
A virtual destructor.
Member Function Documentation
| virtual bool exist | ( | value_type | mass | ) | [pure virtual] |
Returns true if the decomposition for the given mass exists, otherwise - false.
- Parameters:
-
mass Mass to be checked on decomposing.
- Returns:
- true, if the decomposition for
massexist, otherwise - false.
| virtual decompositions_type getAllDecompositions | ( | value_type | mass | ) | [pure virtual] |
Returns all possible decompositions for the given mass.
- Parameters:
-
mass Mass to be decomposed.
- Returns:
- All possible decompositions of the
mass, if there are any exist, otherwise - an empty container.
| virtual decomposition_type getDecomposition | ( | value_type | mass | ) | [pure virtual] |
Returns one possible decomposition of the given mass.
- Parameters:
-
mass Mass to be decomposed.
- Returns:
- The decomposition of the
mass, if one exists, otherwise - an empty container.
| virtual decomposition_value_type getNumberOfDecompositions | ( | value_type | mass | ) | [pure virtual] |
Returns the number of possible decompositions for the given mass.
- Parameters:
-
mass Mass to be decomposed.
- Returns:
- The number of possible decompositions for the
mass.
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:59 using doxygen 1.7.1 |