← Back to branch summary

~ubuntu-branches/ubuntu/vivid/regina-normal/vivid-proposed

« back to all changes in this revision

Viewing changes to engine/engine/subcomplex/nstandardtri.h

  • Committer: Bazaar Package Importer
  • Author(s): Ben Burton
  • Date: 2006-10-29 22:25:06 UTC
  • mfrom: (3.1.7 edgy)
  • Revision ID: james.westby@ubuntu.com-20061029222506-1y63yl1k6pwhhpwq
Tags: 4.3.1-3
Removed www-browser as an alternative to konqueror in regina-normal-doc
recommendations, since the GUI needs konqueror specifically to open the
API docs from the help menu.

Show diffs side-by-side

added added

removed removed

Lines of Context:
engine/engine/subcomplex/nstandardtri.h
4
4
 *  Regina - A Normal Surface Theory Calculator                           *
5
5
 *  Computational Engine                                                  *
6
6
 *                                                                        *
7
 
 *  Copyright (c) 1999-2004, Ben Burton                                   *
 
7
 *  Copyright (c) 1999-2006, Ben Burton                                   *
8
8
 *  For further details contact Ben Burton (bab@debian.org).              *
9
9
 *                                                                        *
10
10
 *  This program is free software; you can redistribute it and/or         *
19
19
 *                                                                        *
20
20
 *  You should have received a copy of the GNU General Public             *
21
21
 *  License along with this program; if not, write to the Free            *
22
 
 *  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,        *
23
 
 *  MA 02111-1307, USA.                                                   *
 
22
 *  Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,       *
 
23
 *  MA 02110-1301, USA.                                                   *
24
24
 *                                                                        *
25
25
 **************************************************************************/
26
26
 
82
82
        std::string getName() const;
83
83
        /**
84
84
         * Returns the name of this specific triangulation in TeX
85
 
         * format.  Leading and trailing dollar signs will be included.
 
85
         * format.  No leading or trailing dollar signs will be included.
 
86
         *
 
87
         * \warning The behaviour of this routine has changed as of
 
88
         * Regina 4.3; in earlier versions, leading and trailing dollar
 
89
         * signs were provided.
86
90
         *
87
91
         * @return the name of this triangulation in TeX format.
88
92
         */
150
154
        virtual std::ostream& writeName(std::ostream& out) const = 0;
151
155
        /**
152
156
         * Writes the name of this triangulation in TeX format
153
 
         * to the given output stream.  Leading and trailing dollar
 
157
         * to the given output stream.  No leading or trailing dollar
154
158
         * signs will be included.
155
159
         *
 
160
         * \warning The behaviour of this routine has changed as of
 
161
         * Regina 4.3; in earlier versions, leading and trailing dollar
 
162
         * signs were provided.
 
163
         *
156
164
         * \ifacespython The parameter \a out does not exist; standard
157
165
         * output will be used.
158
166
         *
174
182
         * boundary faces, i.e., the component cannot have any further
175
183
         * identifications of these boundary faces with each other.
176
184
         *
 
185
         * Note that the triangulation-based routine
 
186
         * isStandardTriangulation(NTriangulation*) may recognise more
 
187
         * triangulations than this routine, since passing an entire
 
188
         * triangulation allows access to more information.
 
189
         *
177
190
         * @param component the triangulation component under examination.
178
191
         * @return the details of the standard triangulation if the
179
192
         * given component is recognised, or 0 otherwise.
191
204
         * boundary faces, i.e., the triangulation cannot have any further
192
205
         * identifications of these boundary faces with each other.
193
206
         *
 
207
         * This routine may recognise more triangulations than the
 
208
         * component-based isStandardTriangulation(NComponent*),
 
209
         * since passing an entire triangulation allows access to
 
210
         * more information.
 
211
         *
194
212
         * @param tri the triangulation under examination.
195
213
         * @return the details of the standard triangualation if the
196
214
         * given triangulation is recognised, or 0 otherwise.