← Back to branch summary

~ubuntu-branches/ubuntu/precise/libbpp-phyl/precise

« back to all changes in this revision

Viewing changes to src/Bpp/Phyl/Io/IoDistanceMatrix.h

  • Committer: Bazaar Package Importer
  • Author(s): Julien Dutheil
  • Date: 2011-06-09 11:00:00 UTC
  • Revision ID: james.westby@ubuntu.com-20110609110000-yvx78svv6w7xxgph
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/Bpp/Phyl/Io/IoDistanceMatrix.h
 
1
//
 
2
// File: IODistanceMatrix.h
 
3
// Created by: Julien Dutheil
 
4
// Created on: Wed Jun 08 15:43 2005
 
5
//
 
6
 
 
7
/*
 
8
Copyright or © or Copr. CNRS, (November 16, 2004)
 
9
 
 
10
This software is a computer program whose purpose is to provide classes
 
11
for phylogenetic data analysis.
 
12
 
 
13
This software is governed by the CeCILL  license under French law and
 
14
abiding by the rules of distribution of free software.  You can  use, 
 
15
modify and/ or redistribute the software under the terms of the CeCILL
 
16
license as circulated by CEA, CNRS and INRIA at the following URL
 
17
"http://www.cecill.info". 
 
18
 
 
19
As a counterpart to the access to the source code and  rights to copy,
 
20
modify and redistribute granted by the license, users are provided only
 
21
with a limited warranty  and the software's author,  the holder of the
 
22
economic rights,  and the successive licensors  have only  limited
 
23
liability. 
 
24
 
 
25
In this respect, the user's attention is drawn to the risks associated
 
26
with loading,  using,  modifying and/or developing or reproducing the
 
27
software by the user in light of its specific status of free software,
 
28
that may mean  that it is complicated to manipulate,  and  that  also
 
29
therefore means  that it is reserved for developers  and  experienced
 
30
professionals having in-depth computer knowledge. Users are therefore
 
31
encouraged to load and test the software's suitability as regards their
 
32
requirements in conditions enabling the security of their systems and/or 
 
33
data to be ensured and,  more generally, to use and operate it in the 
 
34
same conditions as regards security. 
 
35
 
 
36
The fact that you are presently reading this means that you have had
 
37
knowledge of the CeCILL license and that you accept its terms.
 
38
*/
 
39
 
 
40
#ifndef _IODISTANCEMATRIX_H_
 
41
#define _IODISTANCEMATRIX_H_
 
42
 
 
43
#include <Bpp/Io/IoFormat.h>
 
44
 
 
45
// From the STL:
 
46
#include <iostream>
 
47
#include <fstream>
 
48
 
 
49
namespace bpp
 
50
{
 
51
 
 
52
class DistanceMatrix;
 
53
 
 
54
/**
 
55
 * @brief General interface for distance matrix I/O.
 
56
 */
 
57
class IODistanceMatrix:
 
58
  public virtual IOFormat
 
59
{
 
60
        public:
 
61
                IODistanceMatrix() {}
 
62
                virtual ~IODistanceMatrix() {}
 
63
 
 
64
        public:
 
65
                virtual const std::string getDataType() const { return "Distance matrix"; }
 
66
};
 
67
 
 
68
/**
 
69
 * @brief General interface for distance matrix readers.
 
70
 */
 
71
class IDistanceMatrix:
 
72
  public virtual IODistanceMatrix
 
73
{
 
74
        public:
 
75
                IDistanceMatrix() {}
 
76
                virtual ~IDistanceMatrix() {}
 
77
 
 
78
        public:
 
79
    /**
 
80
     * @brief Read a distance matrix from a file.
 
81
     *
 
82
     * @param path The file path.
 
83
     * @return A new distance matrix object.
 
84
     * @throw Exception If an error occured.
 
85
     */
 
86
                virtual DistanceMatrix* read(const std::string& path) const throw (Exception) = 0;
 
87
    /**
 
88
     * @brief Read a distance matrix from a stream.
 
89
     *
 
90
     * @param in The input stream.
 
91
     * @return A new distance matrix object.
 
92
     * @throw Exception If an error occured.
 
93
     */
 
94
                virtual DistanceMatrix* read(std::istream& in) const throw (Exception) = 0;
 
95
};
 
96
 
 
97
/**
 
98
 * @brief General interface for distance matrix writers.
 
99
 */
 
100
class ODistanceMatrix:
 
101
  public virtual IODistanceMatrix
 
102
{
 
103
        public:
 
104
                ODistanceMatrix() {}
 
105
                virtual ~ODistanceMatrix() {}
 
106
 
 
107
        public:
 
108
    /**
 
109
     * @brief Write a distance matrix to a file.
 
110
     *
 
111
     * @param dist A distance matrix object.
 
112
     * @param path The file path.
 
113
     * @param overwrite Tell if existing file must be overwritten.
 
114
     * Otherwise append to the file.
 
115
     * @throw Exception If an error occured.
 
116
     */
 
117
                virtual void write(const DistanceMatrix& dist, const std::string& path, bool overwrite) const throw (Exception) = 0;
 
118
    /**
 
119
     * @brief Write a distance matrix to a stream.
 
120
     *
 
121
     * @param dist A distance matrix object.
 
122
     * @param out The output stream.
 
123
     * @throw Exception If an error occured.
 
124
     */
 
125
                virtual void write(const DistanceMatrix& dist, std::ostream& out) const throw (Exception) = 0;
 
126
};
 
127
 
 
128
/**
 
129
 * @brief Partial implementation of the IDistanceMatrix interface.
 
130
 */
 
131
class AbstractIDistanceMatrix:
 
132
  public virtual IDistanceMatrix
 
133
{
 
134
        public:
 
135
                AbstractIDistanceMatrix() {}
 
136
                virtual ~AbstractIDistanceMatrix() {}
 
137
 
 
138
        public:
 
139
                virtual DistanceMatrix* read(const std::string& path) const throw (Exception)
 
140
                {
 
141
      std::ifstream input(path.c_str(), std::ios::in);
 
142
                        DistanceMatrix* mat = read(input);
 
143
                        input.close();
 
144
                        return mat;
 
145
                }
 
146
                virtual DistanceMatrix* read(std::istream& in) const throw (Exception) = 0;
 
147
};
 
148
 
 
149
/**
 
150
 * @brief Partial implementation of the ODistanceMatrix interface.
 
151
 */
 
152
class AbstractODistanceMatrix:
 
153
  public virtual ODistanceMatrix
 
154
{
 
155
        public:
 
156
                AbstractODistanceMatrix() {}
 
157
                virtual ~AbstractODistanceMatrix() {}
 
158
 
 
159
        public:
 
160
                virtual void write(const DistanceMatrix& dist, const std::string& path, bool overwrite) const throw (Exception)
 
161
                {
 
162
                        // Open file in specified mode
 
163
      std::ofstream output(path.c_str(), overwrite ? (std::ios::out) : (std::ios::out|std::ios::app));
 
164
                        write(dist, output);
 
165
                        output.close();
 
166
                }
 
167
                virtual void write(const DistanceMatrix& dist, std::ostream& out) const throw (Exception) = 0;
 
168
};
 
169
 
 
170
} //end of namespace bpp.
 
171
 
 
172
#endif //_IODISTANCEMATRIX_H_
 
173