File: obsolete.xml

package info (click to toggle)
gap 4r7p5-2
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 29,272 kB
  • ctags: 7,129
  • sloc: ansic: 107,802; xml: 46,868; sh: 3,548; perl: 2,329; makefile: 740; python: 94; asm: 62; awk: 6
file content (237 lines) | stat: -rw-r--r-- 8,483 bytes parent folder | download
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<!-- %% -->
<!-- %W  obsolete.tex             GAP documentation               Frank Lübeck -->
<!-- %%   -->
<!-- %H  @(#)<M>Id: obsolete.tex,v 4.3 2005/08/24 14:31:34 gap Exp </M> -->
<!-- %%   -->
<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Chapter Label="Replaced and Removed Command Names">
<Heading>Replaced and Removed Command Names</Heading>

<#Include Label="obsolete_intro">


<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Section Label="Group Actions - Name Changes">
<Heading>Group Actions &ndash; Name Changes</Heading>

<Index>group operations</Index>

The concept of a group action is sometimes referred to as a
<Q>group operation</Q>.
In &GAP;&nbsp;3 as well as in older versions of &GAP;&nbsp;4 the term
<C>Operation</C> was used instead of <C>Action</C>.
We decided to change the names to avoid confusion with the term
<Q>operation</Q> as in <Ref Func="DeclareOperation"/> and
<Q>operations for Xyz</Q>.
<P/>
Here are some examples of such name changes.
<P/>
<Index Key="Operation"><C>Operation</C></Index>
<Index Key="RepresentativeOperation"><C>RepresentativeOperation</C></Index>
<Index Key="OperationHomomorphism"><C>OperationHomomorphism</C></Index>
<Index Key="FunctionOperation"><C>FunctionOperation</C></Index>
<Table Align="l|l">
<Row>
  <Item><E>OLD</E></Item>
  <Item><E>NOW USE</E></Item>
</Row>
<HorLine/>
<Row>
  <Item><C>Operation</C></Item>
  <Item><Ref Func="Action" Label="for a group, an action domain, etc."/></Item>
</Row>
<Row>
  <Item><C>RepresentativeOperation</C></Item>
  <Item><Ref Func="RepresentativeAction"/></Item>
</Row>
<Row>
  <Item><C>OperationHomomorphism</C></Item>
  <Item><Ref Func="ActionHomomorphism" Label="for a group, an action domain, etc."/></Item>
</Row>
<Row>
  <Item><C>FunctionOperation</C></Item>
  <Item><Ref Func="FunctionAction"/></Item>
</Row>
</Table>

</Section>


<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Section Label="Package Interface - Obsolete Functions and Name Changes">
<Heading>Package Interface &ndash; Obsolete Functions and Name Changes</Heading>

With &GAP;&nbsp;4.4 the package interface was changed. Thereby some functions
became obsolete and the names of some others were made more consistent.
<P/>
<Index Key="DeclarePackage"><C>DeclarePackage</C></Index>
<Index Key="DeclareAutoPackage"><C>DeclareAutoPackage</C></Index>
<Index Key="DeclarePackageDocumentation">
<C>DeclarePackageDocumentation</C></Index>
<Index Key="DeclarePackageAutoDocumentation">
<C>DeclarePackageAutoDocumentation</C></Index>
The following functions are no longer needed:
<C>DeclarePackage</C>,
<C>DeclareAutoPackage</C>,
<C>DeclarePackageDocumentation</C> and 
<C>DeclarePackageAutoDocumentation</C>.
They are substituted by entries in the packages' <F>PackageInfo.g</F> files,
see <Ref Sect="The PackageInfo.g File"/>. 
<P/>
Furthermore, the global variable <C>PACKAGES_VERSIONS</C> is no longer needed,
since this information is now contained in the <C>GAPInfo.PackagesInfo</C> record
(see <Ref Subsect="GAPInfo"/>). The global variable <C>Revisions</C> is also
no longer needed, since the function <C>DisplayRevision</C> was made obsolete in
&GAP;&nbsp;4.5.
<P/>

The following function names were changed.
<P/>
<Index Key="RequirePackage"><C>RequirePackage</C></Index>
<Index Key="ReadPkg"><C>ReadPkg</C></Index>
<Index Key="RereadPkg"><C>RereadPkg</C></Index>
<Table Align="l|l">
<Row>
  <Item><E>OLD</E></Item>
  <Item><E>NOW USE</E></Item>
</Row>
<HorLine/>
<Row>
  <Item><C>RequirePackage</C></Item>
  <Item><Ref Func="LoadPackage"/></Item>
</Row>
<Row>
  <Item><C>ReadPkg</C></Item>
  <Item><Ref Func="ReadPackage"/></Item>
</Row>
<Row>
  <Item><C>RereadPkg</C></Item>
  <Item><Ref Func="RereadPackage"/></Item>
</Row>
</Table>

</Section>


<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Section Label="Normal Forms of Integer Matrices - Name Changes">
<Heading>Normal Forms of Integer Matrices &ndash; Name Changes</Heading>

<Index>Smith normal form</Index>
<Index>Hermite normal form</Index>

Former versions of &GAP;&nbsp;4 documented several functions for computing
the Smith or Hermite normal form of integer matrices.
Some of them were never implemented and it was unclear which commands to use.
The functionality of all of these commands is now available with
<Ref Func="NormalFormIntMat"/> and a few interface functions.

</Section>


<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Section Label="Miscellaneous Name Changes or Removed Names">
<Heading>Miscellaneous Name Changes or Removed Names</Heading>

<Index Key="QUIET"><C>QUIET</C></Index>
<Index Key="BANNER"><C>BANNER</C></Index>

In former releases of &GAP;&nbsp;4 there were some global variable names
bound to general information about the running &GAP;,
such as path names or command line options.
Although they were not officially documented they were used by several users
and in some packages.
We mention here <C>BANNER</C> and <C>QUIET</C>.
This type of information is now collected in the global record
<Ref Var="GAPInfo"/>.
<P/>
Here are some further name changes.
<P/>
<Index Key="MonomialTotalDegreeLess"><C>MonomialTotalDegreeLess</C></Index>
<Index Key="NormedVectors"><C>NormedVectors</C></Index>
<Index Key="MutableIdentityMat"><C>MutableIdentityMat</C></Index>
<Index Key="MutableNullMat"><C>MutableNullMat</C></Index>
<Table Align="l|l">
<Row>
  <Item><E>OLD</E></Item>
  <Item><E>NOW USE</E></Item>
</Row>
<HorLine/>
<Row>
  <Item><C>MonomialTotalDegreeLess</C></Item>
  <Item><Ref Func="MonomialExtGrlexLess"/></Item>
</Row>
<Row>
  <Item><C>NormedVectors</C></Item>
  <Item><Ref Func="NormedRowVectors"/></Item>
</Row>
<Row>
  <Item><C>MutableIdentityMat</C></Item>
  <Item><Ref Func="IdentityMat"/></Item>
</Row>
<Row>
  <Item><C>MutableNullMat</C></Item>
  <Item><Ref Func="NullMat"/></Item>
</Row>
</Table>


<ManSection>
<Var Name="InfoObsolete"/>
<Description>
is an info class to display warnings when an obsolete variable is used.
By default, these warnings are switched off since the info level for 
this class is 0. Setting it to 1 will trigger warnings if &GAP; will 
detect that an obsolete variable is used at runtime (this detection is
possible, however, only for obsolete variables declared using 
<C>DeclareObsoleteSynonym</C>). 
<P/>
To check that the &GAP; code does not use obsolete variables at the 
parsing time, and not at a runtime, use <C>-O</C> command line option,
see <Ref Sect="Command Line Options"/>. 
</Description>
</ManSection>


</Section>


<!-- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -->
<Section Label="obsolete-gaprc">
<Heading>The former .gaprc file</Heading>

Up to &GAP;&nbsp;4.4, a file <F>.gaprc</F> in the user's home directory
(if available, and &GAP; was started without <C>-r</C> option) was 
read automatically during startup,
early enough for influencing the autoloading of packages and
late enough for being allowed to execute any &GAP; code.  On Windows 
machines this file was called <F>gap.rc</F>.
<P/>
In &GAP;&nbsp;4.5 the startup mechanism has changed, see 
<Ref Sect="sect:gap.ini"/> for details. These new configuration
files are now contained in a directory <C>GAPInfo.UserGapRoot</C>.
<P/>
For the sake of partial backwards compatibility,
also the former file <F>~/.gaprc</F> is still supported for such
initializations, but this file is read only if the directory 
<C>GAPInfo.UserGapRoot</C> does not exist.
In that case the <F>~/.gaprc</F> is read at the same time as <F>gaprc</F>
would be read, i.&nbsp;e., too late for influencing the startup of &GAP;.
<P/>
As before, the command line option <C>-r</C> disables reading
<F>~/.gaprc</F>, see <Ref Sect="Command Line Options"/>.
<P/>
To migrate from the old setup to the new one introduced with &GAP;&nbsp;4.5,
first have a look at the function <Ref Func="WriteGapIniFile"/>. Many users
will find that all or most of what was set in the old <F>~/.gaprc</F> file
can now be done via the user preferences in a <F>gap.ini</F> file.
If you had code for new functions or abbreviations in your old <F>~/.gaprc</F> 
file or you were reading additional files, then move this into
the file <F>gaprc</F> (without the leading dot, same name for all operating
systems) in the directory <C>GAPInfo.UserGapRoot</C>.

</Section>
</Chapter>