phy_node.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:4k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: phy_node.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/12 17:53:38  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_PHY_TREE___PHY_NODE__HPP
  10. #define ALGO_PHY_TREE___PHY_NODE__HPP
  11. /*  $Id: phy_node.hpp,v 1000.0 2004/04/12 17:53:38 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Authors:  Josh Cherry
  37.  *
  38.  * File Description:  Things for representing and manipulating
  39.  *          phylogenetic trees
  40.  *
  41.  */
  42. #include <corelib/ncbistd.hpp>
  43. #include <corelib/ncbi_tree.hpp>
  44. BEGIN_NCBI_SCOPE
  45. /// Data contained at each node of a phylogenetic tree.
  46. ///
  47. /// Holds a label (string), a distance (double), and an integer id.
  48. /// Distance may not be set; IsSetDist() reports whether it is.
  49. /// id == -1 indicates that the id is not set.
  50. class NCBI_XALGOPHYTREE_EXPORT CPhyNodeData
  51. {
  52. public:
  53.     CPhyNodeData(void)
  54.         : m_Id(-1), m_DistSet(false)
  55.     {
  56.     }
  57.     int GetId(void) const {return m_Id;}
  58.     void SetId(int id) {m_Id = id;}
  59.     /// Is the distance set?
  60.     bool IsSetDist(void) const {return m_DistSet;}
  61.     /// Return the distance; does NOT check whether it's really set.
  62.     double GetDist(void) const {return m_Dist;}
  63.     void SetDist(double dist) {m_Dist = dist; m_DistSet = true;}
  64.     /// Make it no longer set.
  65.     void ResetDist(void) {m_DistSet = false; m_Dist = 0;}
  66.     const string& GetLabel(void) const {return m_Label;}
  67.     void SetLabel(const string& label) {m_Label = label;}
  68.     string& SetLabel(void) {return m_Label;}
  69. private:
  70.     int m_Id;
  71.     double m_Dist;
  72.     bool m_DistSet;
  73.     string m_Label;
  74. };
  75. typedef CTreeNode<CPhyNodeData> TPhyTreeNode;
  76. /// Newick format output
  77. NCBI_XALGOPHYTREE_EXPORT
  78. CNcbiOstream& operator<<(CNcbiOstream& os, const TPhyTreeNode& tree);
  79. /// Nexus format output (Newick with some stuff around it).
  80. ///
  81. /// tree_name gets put in the file.
  82. NCBI_XALGOPHYTREE_EXPORT
  83. void WriteNexusTree(CNcbiOstream& os, const TPhyTreeNode& tree,
  84.                     const string& tree_name = "the_tree");
  85. /// Newick but without the terminal ';'
  86. NCBI_XALGOPHYTREE_EXPORT
  87. void PrintNode(CNcbiOstream& os, const TPhyTreeNode& node);
  88. /// Newick format input.
  89. ///
  90. /// Uses flex/bison lexer/parser.
  91. NCBI_XALGOPHYTREE_EXPORT
  92. TPhyTreeNode *ReadNewickTree(CNcbiIstream& is);
  93. END_NCBI_SCOPE
  94. /*
  95.  * ===========================================================================
  96.  * $Log: phy_node.hpp,v $
  97.  * Revision 1000.0  2004/04/12 17:53:38  gouriano
  98.  * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.4
  99.  *
  100.  * Revision 1.4  2004/02/11 21:50:23  jcherry
  101.  * Added Nexus format output
  102.  *
  103.  * Revision 1.3  2004/02/11 17:54:43  jcherry
  104.  * Added parser for Newick format tree files
  105.  *
  106.  * Revision 1.2  2004/02/10 17:02:29  dicuccio
  107.  * Formatting changes.  Added export specifiers
  108.  *
  109.  * Revision 1.1  2004/02/10 15:15:57  jcherry
  110.  * Initial version
  111.  *
  112.  * ===========================================================================
  113.  */
  114. #endif  // ALGO_PHY_TREE___PHY_NODE__HPP