1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2012, Ben Burton *
* For further details contact Ben Burton (bab@debian.org). *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* You should have received a copy of the GNU General Public *
* License along with this program; if not, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301, USA. *
* *
**************************************************************************/
/* end stub */
/*! \file foreign/recogniser.h
* \brief Allows exports to Matveev's 3-manifold recogniser.
*/
#ifndef __RECOGNISER_H
#ifndef __DOXYGEN
#define __RECOGNISER_H
#endif
#include <string>
#include "regina-core.h"
namespace regina {
class NTriangulation;
/**
* \weakgroup foreign
* @{
*/
/**
* Writes the given triangulation to the given file in Matveev's 3-manifold
* recogniser format.
*
* \pre The given triangulation is not invalid, and does not contain any
* boundary faces.
*
* \i18n This routine makes no assumptions about the
* \ref i18n "character encoding" used in the given file \e name, and
* simply passes it through unchanged to low-level C/C++ file I/O routines.
* The \e contents of the file will be written using UTF-8.
*
* @param filename the name of the Recogniser file to which to write.
* This may be the null pointer (or the empty string), in which case the
* data will be written to standard output instead.
* @param tri the triangulation to write to the Recogniser file.
* @return \c true if the export was successful, or \c false otherwise.
*/
REGINA_API bool writeRecogniser(const char* filename, NTriangulation& tri);
/**
* A synonym for writeRecogniser(). See writeRecogniser() for details.
*/
REGINA_API bool writeRecognizer(const char* filename, NTriangulation& tri);
/*@}*/
// Inline functions:
inline bool writeRecognizer(const char* filename, NTriangulation& tri) {
return writeRecogniser(filename, tri);
}
} // namespace regina
#endif
|
