---

LibrarySet Class Reference

#include <LibrarySet.h>

List of all members.

Public Methods
	LibrarySet (void)
virtual	~LibrarySet ()
void	initialize (void)
void	addLibrary (Library *p_library)
void	addLibrary (std::vector< Library * > &p_libraries)
IndexType	getSetSize (void) const
IndexType	getInitialSetSize (void) const
void	goFirst (void)
void	goNext (void)
void	goPrevious (void)
void	goTo (IndexType p_index)
bool	isLast (void) const
bool	isFirst (void) const
bool	isEnd (void) const
void	buildCompositeFragment (CompositeFragment &p_composite_fragment)
std::vector< Library * > &	getLibraries (void)
std::string	getCompositionString (void)
std::string	getLibrarySetName (void) const
void	setLibrarySetName (const std::string &p_name)
double	getEffectiveness (void)

---

Detailed Description

This class contains a list of libraries and is used to generate all the combinatorial products. The combinatorial products are not conserved in memory and the navigation through them is done with an iterator-like interface.

---

Constructor & Destructor Documentation

LibrarySet::LibrarySet (  void    )

Default constructor.

virtual LibrarySet::~LibrarySet (    )  [inline, virtual]

Default destructor.

---

Member Function Documentation

void LibrarySet::addLibrary (  std::vector< Library * > &    p_libraries )  [inline]

Add a list of library at once to the object Library list.

void LibrarySet::addLibrary (  Library *    p_library )  [inline]

Add a Library to the Library list.

void LibrarySet::buildCompositeFragment (  CompositeFragment &    p_composite_fragment )

Build a CompositeFragment generated by the combination of Fragment objects associated to the current position of the internal iterator. Parameters: p_composite_fragment  This method links the current Fragment objects to this argument.

std::string LibrarySet::getCompositionString (  void    )

Return a text of the size of the libraries. Ex. 128 x 874 x 501 = 56047872

double LibrarySet::getEffectiveness (  void    )

Return the effectiveness defined as: 1/number_of_libraries * SUM[over all Library 'i'] ( number_of_remaining_reagent_in_Library(i) / number_of_initial_reagent_in_Library(i) )

IndexType LibrarySet::getInitialSetSize (  void    )  const [inline]

Return the number of combinations that can be formed with the libraries before any pruning occured.

std::vector<Library*>& LibrarySet::getLibraries (  void    )  [inline]

Return the Library list used to generate the combinatorial products.

std::string LibrarySet::getLibrarySetName (  void    )  const [inline]

Getter of the LibrarySet name.

IndexType LibrarySet::getSetSize (  void    )  const [inline]

Return the number of combinations that can be formed with the actual libraries.

void LibrarySet::goFirst (  void    )  [inline]

Position the internal iterator to the first element of the combinatorial product list.

void LibrarySet::goNext (  void    )  [inline]

Advance the internal iterator to the next element of the combinatorial product list.

void LibrarySet::goPrevious (  void    )  [inline]

Go back one position in the combinatorial product list.

void LibrarySet::goTo (  IndexType    p_index )  [inline]

Move to a specific combinatorial product. Parameters: p_index  Index of the combinatorial product to move the internal iterator to.

void LibrarySet::initialize (  void    )

Empty the Library list.

bool LibrarySet::isEnd (  void    )  const [inline]

Return 'true' if the current position of the internal iterator is passed the last element of the combinatorial product list. Return 'false' otherwise.

bool LibrarySet::isFirst (  void    )  const [inline]

Return 'true' if the current position of the internal iterator is on the first element of the combinatorial product list. Return 'false' otherwise.

bool LibrarySet::isLast (  void    )  const [inline]

Return 'true' if the current position of the internal iterator is on the last element of the combinatorial product list. Return 'false' otherwise.

void LibrarySet::setLibrarySetName (  const std::string &    p_name )  [inline]

Setter of the LibrarySet name.

---

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

• LibrarySet.h

---