Generated on Fri Mar 20 12:35:20 2009 for cpsp-2.3.1 by doxygen 1.5.5

cpsp::scth::SideChainThreadingHandler Class Reference

#include <chain_threading_all.h>


Detailed Description

This class is for side chain handler, it applies the constraint threading for the most optimal Core till the less until a solution is found.

Definition at line 47 of file chain_threading_all.h.


Public Member Functions

int getSolutionsNum ()
 SideChainThreadingHandler (const SideChainOptions &)

Private Member Functions

int calculateCoreSize (std::string *seq)
pair< int, int > checkHCoreParity (const HCore *hCore)
pair< int, int > checkParity (const std::string *seq)
bool checkSequenceHCoreParity (const std::string *seq, const HCore *hCore)

Private Attributes

int solutionsNum

Constructor & Destructor Documentation

cpsp::scth::SideChainThreadingHandler::SideChainThreadingHandler ( const SideChainOptions option  ) 

The constructor gets the Side chain options as the only input.

Definition at line 90 of file chain_threading_all.cpp.


Member Function Documentation

int cpsp::scth::SideChainThreadingHandler::calculateCoreSize ( std::string *  seq  )  [private]

A simple function returns the number of Hs in the sequence

Parameters:
seq The sequence string
Returns:
the number of Hs

Definition at line 37 of file chain_threading_all.cpp.

pair< int, int > cpsp::scth::SideChainThreadingHandler::checkHCoreParity ( const HCore hCore  )  [private]

This function returns as a pair the number of odd and even points of the HCore

Returns:
pair representing the number of odd (first) and even (second) points of the HCore

Definition at line 61 of file chain_threading_all.cpp.

pair< int, int > cpsp::scth::SideChainThreadingHandler::checkParity ( const std::string *  seq  )  [private]

This function returns as a pair the number of odd and even Hs in the sequence

Returns:
pair representing the number of odd (first) and even (second) number of Hs

Definition at line 48 of file chain_threading_all.cpp.

bool cpsp::scth::SideChainThreadingHandler::checkSequenceHCoreParity ( const std::string *  seq,
const HCore hCore 
) [private]

In the case of Cubic lattice only (not the FCC), this function will apply the parity check of the sequence against the Core

Returns:
true if the parity check of the sequence against the hCore holds otherwise false

Definition at line 77 of file chain_threading_all.cpp.

int cpsp::scth::SideChainThreadingHandler::getSolutionsNum (  ) 

Definition at line 197 of file chain_threading_all.cpp.


Field Documentation

number of found solutions

Definition at line 71 of file chain_threading_all.h.


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