CTableauLine.h

Go to the documentation of this file.

/* Begin CVS Header
   $Source: /Volumes/Home/Users/shoops/cvs/copasi_dev/copasi/elementaryFluxModes/CTableauLine.h,v $
   $Revision: 1.12 $
   $Name:  $
   $Author: heilmand $
   $Date: 2010/08/02 15:12:05 $
   End CVS Header */

// Copyright (C) 2010 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., University of Heidelberg, and The University
// of Manchester.
// All rights reserved.

// Copyright (C) 2008 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc., EML Research, gGmbH, University of Heidelberg,
// and The University of Manchester.
// All rights reserved.

// Copyright (C) 2001 - 2007 by Pedro Mendes, Virginia Tech Intellectual
// Properties, Inc. and EML Research, gGmbH.
// All rights reserved.

/**
 *  CTableauLine class.
 *  This store one row of the Tableau Matrix
 *
 *  Created for COPASI by Stefan Hoops 2002-05-08
 * (C) Stefan Hoops 2002
 */

#ifndef COPASI_CTableauLine
#define COPASI_CTableauLine

#include <vector>
#include "elementaryFluxModes/CFluxScore.h"

class CTableauLine
{
  friend std::ostream & operator << (std::ostream &, const CTableauLine &);
  // Attributes

private:
  /**
   *
   */
  std::vector <C_FLOAT64> mReaction;

  /**
   *
   */
  bool mReversible;

  /**
   *
   */
  std::vector <C_FLOAT64> mFluxMode;

  /**
   *
   */
  CFluxScore *mpFluxScore;

  // Operations

public:
  /**
   *  Default constructor
   */
  CTableauLine();

  /**
   *  Specific constructor
   */
  CTableauLine(const std::vector <C_FLOAT64> & reaction,
               bool reversible,
               const size_t & reactionCounter,
               const size_t & reactionNumber);

  /**
   *  Specific constructor
   */
  CTableauLine(C_FLOAT64 m1,
               const CTableauLine & src1,
               C_FLOAT64 m2,
               const CTableauLine & src2);

  /**
   *  Destructor
   */
  ~CTableauLine();

  /**
   *  Retrieves the flux score
   */
  const CFluxScore & getScore() const;

  /**
   * Retrieve the multiplier for this reaction for the indexed species
   * @param const size_t & index
   * @return const C_FLOAT64 & multiplier
   */
  const C_FLOAT64 & getMultiplier(const size_t & index) const;

  /**
   *  Retrieves the flux mode
   */
  const std::vector < C_FLOAT64 > & getFluxMode() const;

  /**
   *  Checks whether the reaction is reversible
   *  @return "bool" isReversible
   */
  bool isReversible() const;

  /**
   *  Remove the first entry from the reaction vector
   */
  // void truncate();

private:
  /**
   * Divides m1 and m2 by the largest common factor.
   */
  static void reduce(C_FLOAT64 & r1, C_FLOAT64 & r2);
};

#endif // COPASI_CTableauLine