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

« back to all changes in this revision

Viewing changes to qtui/doc/regina/utils.docbook

  • Committer: Package Import Robot
  • Author(s): Ben Burton
  • Date: 2014-08-29 17:37:46 UTC
  • mfrom: (19.1.1 sid)
  • Revision ID: package-import@ubuntu.com-20140829173746-igmqc9b67y366a7u
Tags: 4.96-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
 
12
12
 <!-- File Concatenator -->
13
13
 
 
14
 <refentry id="man-censuslookup">
 
15
  <refmeta>
 
16
   <refentrytitle>censuslookup</refentrytitle>
 
17
   <manvolnum>1</manvolnum>
 
18
  </refmeta>
 
19
 
 
20
  <refnamediv>
 
21
   <refname>censuslookup</refname>
 
22
   <refpurpose>Search for triangulations in &regina;'s census databases</refpurpose>
 
23
  </refnamediv>
 
24
 
 
25
  <refsynopsisdiv>
 
26
   <cmdsynopsis>
 
27
    <command>censuslookup</command>
 
28
    <arg rep="repeat" choice="req"><replaceable>isosig</replaceable></arg>
 
29
   </cmdsynopsis>
 
30
  </refsynopsisdiv>
 
31
 
 
32
  <refsect1>
 
33
   <title>Description</title>
 
34
   <para>
 
35
    This utility searches for the given 3-manifold triangulations in the various
 
36
    census databases that are shipped with&regina;.
 
37
   </para>
 
38
   <para>
 
39
    You should present the trianguations using their <firstterm>isomorphism
 
40
    signatures</firstterm>.  These are short text strings that identify
 
41
    the triangulation uniquely up to combinatorial isomorphism
 
42
    (i.e., up to relabellings of the tetrahedra and/or their vertices).
 
43
   </para>
 
44
   <para>
 
45
    From the graphical user interface, you can view the isomorphism signature
 
46
    of a triangulation by switching to the <guilabel>Composition</guilabel>
 
47
    tab in the triangulation viewer.  From &python; you can fetch the
 
48
    isomorphism signature of the triangulation <userinput>x</userinput>
 
49
    by calling <userinput>x.isoSig()</userinput>.
 
50
    For a full and precise specification of isomorphism signatures, see
 
51
    <emphasis>Simplification paths in the Pachner graphs of closed
 
52
    orientable 3-manifold triangulations</emphasis>, Burton, 2011,
 
53
    arXiv:1110.6080.
 
54
   </para>
 
55
   <para>
 
56
    All database matches (if any) will be written to standard output.
 
57
   </para>
 
58
  </refsect1>
 
59
 
 
60
  <refsect1>
 
61
   <title>Example</title>
 
62
 
 
63
<screen>
 
64
    <prompt>example$</prompt> <userinput>censuslookup fvPQcdecedekrsnrs dLQbcccajqs cPcbbbiht</userinput>
 
65
    fvPQcdecedekrsnrs: 1 hit
 
66
        SFS [S2: (2,1) (3,1) (5,-4)] : #1 -- Closed census (orientable)
 
67
 
 
68
    dLQbcccajqs: 0 hits
 
69
 
 
70
    cPcbbbiht: 2 hits
 
71
        m004 : #1 -- Cusped hyperbolic census (orientable)
 
72
        L104001 -- Hyperbolic knot and link complements
 
73
 
 
74
    <prompt>example$</prompt>
 
75
</screen>
 
76
  </refsect1>
 
77
 
 
78
  <refsect1>
 
79
   <title>&macosx; Users</title>
 
80
   <para>
 
81
    If you downloaded a drag-and-drop app bundle, this utility is
 
82
    shipped inside it.  If you dragged &regina; to the main
 
83
    <guilabel>Applications</guilabel> folder, you can run it as
 
84
    <literal>/Applications/Regina.app/Contents/MacOS/censuslookup</literal>.
 
85
   </para>
 
86
  </refsect1>
 
87
 
 
88
  <refsect1>
 
89
   <title>&windows; Users</title>
 
90
   <para>
 
91
    The command-line utilities are installed beneath the
 
92
    <filename>Program&nbsp;Files</filename> directory; on some
 
93
    machines this directory is called
 
94
    <filename>Program&nbsp;Files&nbsp;(x86)</filename>.
 
95
    You can start this utility by running
 
96
    <literal>c:\Program&nbsp;Files\Regina\Regina&nbsp;&regversion;\bin\censuslookup.exe</literal>.
 
97
   </para>
 
98
  </refsect1>
 
99
 
 
100
  <refsect1>
 
101
   <title>See Also</title>
 
102
   <para>
 
103
    <link linkend="man-regina-gui">regina-gui</link>.
 
104
    <link linkend="man-trisetcmp">trisetcmp</link>,
 
105
   </para>
 
106
  </refsect1>
 
107
 
 
108
  <refsect1>
 
109
   <title>Author</title>
 
110
   <para>
 
111
    This utility was written by Benjamin Burton <email>bab@debian.org</email>.
 
112
    &manpageack;
 
113
   </para>
 
114
  </refsect1>
 
115
 </refentry>
 
116
 
14
117
 <refentry id="man-regconcat">
15
118
  <refmeta>
16
119
   <refentrytitle>regconcat</refentrytitle>
490
593
  <refsect1>
491
594
   <title>See Also</title>
492
595
   <para>
 
596
    <link linkend="man-censuslookup">censuslookup</link>,
493
597
    <link linkend="man-tricensus">tricensus</link>,
494
598
    <link linkend="man-tricensus-mpi">tricensus-mpi</link>,
495
599
    <link linkend="man-regina-gui">regina-gui</link>.
540
644
     <arg><option>-m, --minimal</option></arg>
541
645
     <arg><option>-M, --minprime</option></arg>
542
646
     <arg><option>-N, --minprimep2</option></arg>
 
647
     <arg><option>-h, --minhyp</option></arg>
543
648
    </group>
544
649
    <group>
545
650
     <arg><option>-s, --sigs</option></arg>
782
887
     </listitem>
783
888
    </varlistentry>
784
889
    <varlistentry>
 
890
     <term><option>-h, --minhyp</option></term>
 
891
     <listitem>
 
892
      <para>
 
893
       Do not include triangulations that are obviously not
 
894
       minimal ideal triangulations of cusped finite-volume hyperbolic
 
895
       3-manifolds.
 
896
      </para>
 
897
      <para>
 
898
       This can significantly speed up the census and vastly
 
899
       reduce the final number of triangulations produced.
 
900
      </para>
 
901
      <para>
 
902
       As above, this option uses a series of fast tests that are not
 
903
       always conclusive.
 
904
       If &regina; cannot quickly tell whether a triangulation is a
 
905
       minimal ideal triangulation of a cusped finite-volume hyperbolic
 
906
       3-manifold,
 
907
       it will place the triangulation in the census regardless.
 
908
      </para>
 
909
      <para>
 
910
       This option is designed for use with ideal triangulations only
 
911
       (so, for instance, combining it with
 
912
       <option>--finite</option> or <option>--boundary</option>
 
913
       will produce an error message).
 
914
       This option also cannot be used with <option>--dim2</option>.
 
915
      </para>
 
916
     </listitem>
 
917
    </varlistentry>
 
918
    <varlistentry>
785
919
     <term><option>-s, --sigs</option></term>
786
920
     <listitem>
787
921
      <para>
1018
1152
  <refsect1>
1019
1153
   <title>See Also</title>
1020
1154
   <para>
 
1155
    <link linkend="man-censuslookup">censuslookup</link>,
1021
1156
    <link linkend="man-sigcensus">sigcensus</link>,
1022
1157
    <link linkend="man-tricensus-mpi">tricensus-mpi</link>,
1023
1158
    <link linkend="man-regina-gui">regina-gui</link>.
1064
1199
     <arg><option>-m, --minimal</option></arg>
1065
1200
     <arg><option>-M, --minprime</option></arg>
1066
1201
     <arg><option>-N, --minprimep2</option></arg>
 
1202
     <arg><option>-h, --minhyp</option></arg>
1067
1203
    </group>
1068
1204
    <arg><option>-s, --sigs</option></arg>
1069
1205
    <arg choice="req"><replaceable>pairs-file</replaceable></arg>
1379
1515
  <refsect1>
1380
1516
   <title>See Also</title>
1381
1517
   <para>
 
1518
    <link linkend="man-censuslookup">censuslookup</link>,
1382
1519
    <link linkend="man-regconcat">regconcat</link>,
1383
1520
    <link linkend="man-sigcensus">sigcensus</link>,
1384
1521
    <link linkend="man-tricensus">tricensus</link>,
1480
1617
  <refsect1>
1481
1618
   <title>See Also</title>
1482
1619
   <para>
 
1620
    <link linkend="man-censuslookup">censuslookup</link>,
1483
1621
    <link linkend="man-tricensus-mpi">tricensus-mpi</link>,
1484
1622
    <link linkend="man-regina-gui">regina-gui</link>.
1485
1623
   </para>
1622
1760
  <refsect1>
1623
1761
   <title>See Also</title>
1624
1762
   <para>
 
1763
    <link linkend="man-censuslookup">censuslookup</link>,
1625
1764
    <link linkend="man-regina-gui">regina-gui</link>.
1626
1765
   </para>
1627
1766
  </refsect1>