pike.git/ src/ operators.c

Branch: Tag:

2003-04-07

2003-04-07 17:28:56 by Martin Nilsson <mani@lysator.liu.se>

Use @expr where more approrpiate than @tt

Rev: lib/modules/ADT.pmod/Table.pmod:1.26
Rev: lib/modules/Crypto.pmod/aes.pike:1.2
Rev: lib/modules/Getopt.pmod:1.27
Rev: lib/modules/Parser.pmod/module.pmod:1.18
Rev: lib/modules/Protocols.pmod/DNS.pmod:1.72
Rev: lib/modules/Protocols.pmod/HTTP.pmod/Query.pike:1.56
Rev: lib/modules/Protocols.pmod/HTTP.pmod/Session.pike:1.11
Rev: lib/modules/Protocols.pmod/HTTP.pmod/module.pmod:1.37
Rev: lib/modules/Protocols.pmod/LDAP.pmod/client.pike:1.48
Rev: lib/modules/Protocols.pmod/Line.pmod:1.22
Rev: lib/modules/Protocols.pmod/SMTP.pmod:1.22
Rev: lib/modules/Sql.pmod/Sql.pike:1.64
Rev: lib/modules/Stdio.pmod/module.pmod:1.169
Rev: lib/modules/String.pmod/module.pmod:1.14
Rev: lib/modules/Tools.pmod/AutoDoc.pmod/ProcessXML.pmod:1.54
Rev: src/builtin.cmod:1.131
Rev: src/builtin_functions.c:1.483
Rev: src/cpp.c:1.117
Rev: src/dynamic_load.c:1.69
Rev: src/error.c:1.106
Rev: src/modules/DVB/dvb.c:1.19
Rev: src/modules/Gdbm/gdbmmod.c:1.24
Rev: src/modules/Gettext/gettext.c:1.15
Rev: src/modules/Gmp/mpf.cmod:1.25
Rev: src/modules/MIME/mime.c:1.37
Rev: src/modules/Mird/module.pmod.in:1.12
Rev: src/modules/Msql/msqlmod.c:1.25
Rev: src/modules/Mysql/mysql.c:1.71
Rev: src/modules/Mysql/result.c:1.29
Rev: src/modules/Yp/module.pmod.in:1.19
Rev: src/modules/_Charset/module.pmod.in:1.31
Rev: src/modules/_Crypto/arcfour.c:1.21
Rev: src/modules/_Crypto/cast.c:1.16
Rev: src/modules/_Crypto/des.c:1.28
Rev: src/modules/_Crypto/idea.c:1.22
Rev: src/modules/_Crypto/invert.c:1.17
Rev: src/modules/_Crypto/md2.c:1.17
Rev: src/modules/_Crypto/md4.c:1.6
Rev: src/modules/_Crypto/pipe.c:1.26
Rev: src/modules/_Crypto/rijndael.c:1.11
Rev: src/modules/_Crypto/sha.c:1.25
Rev: src/modules/_Ffmpeg/ffmpeg.c:1.17
Rev: src/modules/_math/math.c:1.60
Rev: src/modules/files/efuns.c:1.126
Rev: src/modules/files/file.c:1.267
Rev: src/modules/files/stat.c:1.27
Rev: src/modules/files/udp.c:1.43
Rev: src/modules/system/passwords.c:1.41
Rev: src/modules/system/system.c:1.142
Rev: src/operators.c:1.174
Rev: src/pike_search.c:1.15
Rev: src/post_modules/_ADT/circular_list.cmod:1.5
Rev: src/post_modules/_ADT/sequence.cmod:1.6
Rev: src/program.c:1.498
Rev: src/security.c:1.42
Rev: src/signal_handler.c:1.262

2:   || This file is part of Pike. For copyright information see COPYRIGHT.   || Pike is distributed under GPL, LGPL and MPL. See the file COPYING   || for more information. - || $Id: operators.c,v 1.173 2003/04/01 18:11:09 nilsson Exp $ + || $Id: operators.c,v 1.174 2003/04/07 17:28:55 nilsson Exp $   */      #include "global.h"   #include <math.h> - RCSID("$Id: operators.c,v 1.173 2003/04/01 18:11:09 nilsson Exp $"); + RCSID("$Id: operators.c,v 1.174 2003/04/07 17:28:55 nilsson Exp $");   #include "interpret.h"   #include "svalue.h"   #include "multiset.h"
65:    *! Inequality operator.    *!    *! @returns -  *! Returns @tt{0@} (zero) if all the arguments are equal, and -  *! @tt{1@} otherwise. +  *! Returns @expr{0@} (zero) if all the arguments are equal, and +  *! @expr{1@} otherwise.    *!    *! This is the inverse of @[`==()].    *!
85:    *! Equality operator.    *!    *! @returns -  *! Returns @tt{1@} if all the arguments are equal, and -  *! @tt{0@} (zero) otherwise. +  *! Returns @expr{1@} if all the arguments are equal, and +  *! @expr{0@} (zero) otherwise.    *!    *! @seealso    *! @[`!=()]
98:    *! Less than operator.    *!    *! @returns -  *! Returns @tt{1@} if the arguments are strictly increasing, and -  *! @tt{0@} (zero) otherwise. +  *! Returns @expr{1@} if the arguments are strictly increasing, and +  *! @expr{0@} (zero) otherwise.    *!    *! @seealso    *! @[`<=()], @[`>()], @[`>=()]
111:    *! Less or equal operator.    *!    *! @returns -  *! Returns @tt{1@} if the arguments are not strictly decreasing, and -  *! @tt{0@} (zero) otherwise. +  *! Returns @expr{1@} if the arguments are not strictly decreasing, and +  *! @expr{0@} (zero) otherwise.    *!    *! This is the inverse of @[`>()].    *!
126:    *! Greater than operator.    *!    *! @returns -  *! Returns @tt{1@} if the arguments are strictly decreasing, and -  *! @tt{0@} (zero) otherwise. +  *! Returns @expr{1@} if the arguments are strictly decreasing, and +  *! @expr{0@} (zero) otherwise.    *!    *! @seealso    *! @[`<()], @[`<=()], @[`>=()]
139:    *! Greater or equal operator.    *!    *! @returns -  *! Returns @tt{1@} if the arguments are not strictly increasing, and -  *! @tt{0@} (zero) otherwise. +  *! Returns @expr{1@} if the arguments are not strictly increasing, and +  *! @expr{0@} (zero) otherwise.    *!    *! This is the inverse of @[`<()].    *!
217:    *! @note    *! In Pike 7.0 and earlier the addition order was unspecified.    *! -  *! If @[arg1] is @tt{UNDEFINED@} it will behave as the empty +  *! If @[arg1] is @expr{UNDEFINED@} it will behave as the empty    *! array/mapping/multiset if needed. This behaviour was new    *! in Pike 7.0.    *!
1079:    *! If there are more than two arguments the result will be:    *! @expr{`-(`-(@[arg1], @[arg2]), @@@[extras])@}.    *! -  *! If @[arg1] is an object that overloads @tt{`-()@}, that function will +  *! If @[arg1] is an object that overloads @expr{`-()@}, that function will    *! be called with @[arg2] as the single argument.    *! -  *! If @[arg2] is an object that overloads @tt{``-()@}, that function will +  *! If @[arg2] is an object that overloads @expr{``-()@}, that function will    *! be called with @[arg1] as the single argument.    *!    *! Otherwise the result will be as follows:
2924:    *! If @[arg] is an object that implements @[lfun::`!()], that function    *! will be called.    *! -  *! If @[arg] is @tt{0@} (zero), a destructed object, or a function in a -  *! destructed object, @tt{1@} will be returned. +  *! If @[arg] is @expr{0@} (zero), a destructed object, or a function in a +  *! destructed object, @expr{1@} will be returned.    *! -  *! Otherwise @tt{0@} (zero) will be returned. +  *! Otherwise @expr{0@} (zero) will be returned.    *!    *! @seealso    *! @[`==()], @[`!=()], @[lfun::`!()]
3197:    *! with @[index] will be returned.    *! @type mapping    *! If @[index] exists in @[arg] the corresponding value will be -  *! returned. Otherwise @tt{UNDEFINED@} will be returned. +  *! returned. Otherwise @expr{UNDEFINED@} will be returned.    *! @type multiset -  *! If @[index] exists in @[arg], @tt{1@} will be returned. -  *! Otherwise @tt{UNDEFINED@} will be returned. +  *! If @[index] exists in @[arg], @expr{1@} will be returned. +  *! Otherwise @expr{UNDEFINED@} will be returned.    *! @type string    *! The character (int) at index @[index] in @[arg] will be returned.    *! @type program
3269:    *! will be returned.    *! @type mapping    *! If @[index] exists in @[arg] the corresponding value will be -  *! returned. Otherwise @tt{UNDEFINED@} will be returned. +  *! returned. Otherwise @expr{UNDEFINED@} will be returned.    *! @type multiset -  *! If @[index] exists in @[arg], @tt{1@} will be returned. -  *! Otherwise @tt{UNDEFINED@} will be returned. +  *! If @[index] exists in @[arg], @expr{1@} will be returned. +  *! Otherwise @expr{UNDEFINED@} will be returned.    *! @type program    *! The non-static (ie public) constant symbol @[index] will be    *! looked up in @[arg].
3317:    *! @type array|mapping    *! Index @[index] in @[arg] will be assigned @[val].    *! @type multiset -  *! If @[val] is @tt{0@} (zero), one occurrance of @[index] in +  *! If @[val] is @expr{0@} (zero), one occurrance of @[index] in    *! @[arg] will be removed. Otherwise @[index] will be added    *! to @[arg] if it is not already there.    *! @endmixed
3366:    *! @type array|mapping    *! Index @[index] in @[arg] will be assigned @[val].    *! @type multiset -  *! If @[val] is @tt{0@} (zero), one occurrance of @[index] in +  *! If @[val] is @expr{0@} (zero), one occurrance of @[index] in    *! @[arg] will be removed. Otherwise @[index] will be added    *! to @[arg] if it is not already there.    *! @endmixed