Changeset: a568b9d63ec5 for MonetDB URL: https://dev.monetdb.org/hg/MonetDB/rev/a568b9d63ec5 Modified Files: clients/Tests/MAL-signatures-hge.test clients/Tests/MAL-signatures.test monetdb5/modules/atoms/json.c monetdb5/modules/atoms/mtime.c monetdb5/modules/atoms/xml.c monetdb5/modules/kernel/algebra.c monetdb5/modules/kernel/bat5.c monetdb5/modules/kernel/microbenchmark.c monetdb5/modules/kernel/mmath.c monetdb5/modules/mal/calc.c monetdb5/modules/mal/clients.c monetdb5/modules/mal/language.c monetdb5/modules/mal/mal_io.c monetdb5/modules/mal/mat.c monetdb5/modules/mal/mdb.c monetdb5/modules/mal/mkey.c monetdb5/modules/mal/pcre.c monetdb5/modules/mal/tracer.c sql/backends/monet5/sql.c Branch: default Log Message:
Cleanup MAL command/pattern comments. Replace \n with space, remove trailing space. diffs (truncated from 1913 to 300 lines): diff --git a/clients/Tests/MAL-signatures-hge.test b/clients/Tests/MAL-signatures-hge.test --- a/clients/Tests/MAL-signatures-hge.test +++ b/clients/Tests/MAL-signatures-hge.test @@ -287,7 +287,7 @@ aggr count command aggr.count(X_0:bat[:any], X_1:bat[:oid], X_2:bit):lng ALGcountCND_nil -Return the number of elements currently in a BAT ignores@BUNs with nil-tail iff ignore_nils==TRUE. +Return the number of elements currently in a BAT ignores BUNs with nil-tail iff ignore_nils==TRUE. aggr count command aggr.count(X_0:bat[:any]):lng @@ -297,7 +297,7 @@ aggr count command aggr.count(X_0:bat[:any], X_1:bit):lng ALGcount_nil -Return the number of elements currently in a BAT ignores@BUNs with nil-tail iff ignore_nils==TRUE. +Return the number of elements currently in a BAT ignores BUNs with nil-tail iff ignore_nils==TRUE. aggr count_no_nil command aggr.count_no_nil(X_0:bat[:any_1], X_1:bat[:oid], X_2:bat[:any_2]):bat[:lng] @@ -307,12 +307,12 @@ aggr count_no_nil command aggr.count_no_nil(X_0:bat[:any_2], X_1:bat[:oid]):lng ALGcountCND_no_nil -Return the number of elements currently@in a BAT ignoring BUNs with nil-tail +Return the number of elements currently in a BAT ignoring BUNs with nil-tail aggr count_no_nil command aggr.count_no_nil(X_0:bat[:any_2]):lng ALGcount_no_nil -Return the number of elements currently@in a BAT ignoring BUNs with nil-tail +Return the number of elements currently in a BAT ignoring BUNs with nil-tail aggr covariance command aggr.covariance(X_0:bat[:bte], X_1:bat[:bte], X_2:bat[:oid], X_3:bat[:any_1]):bat[:dbl] @@ -3422,7 +3422,7 @@ algebra crossproduct command algebra.crossproduct(X_0:bat[:any_1], X_1:bat[:any_2], X_2:bit) (X_3:bat[:oid], X_4:bat[:oid]) ALGcrossproduct2 -Returns 2 columns with all BUNs, consisting of the head-oids@from 'left' and 'right' for which there are BUNs in 'left'@and 'right' with equal tails +Returns 2 columns with all BUNs, consisting of the head-oids from 'left' and 'right' for which there are BUNs in 'left' and 'right' with equal tails algebra crossproduct command algebra.crossproduct(X_0:bat[:any_1], X_1:bat[:any_2], X_2:bat[:oid], X_3:bat[:oid], X_4:bit) (X_5:bat[:oid], X_6:bat[:oid]) @@ -3522,7 +3522,7 @@ algebra likejoin command algebra.likejoin(X_0:bat[:str], X_1:bat[:str], X_2:bat[:str], X_3:bat[:bit], X_4:bat[:oid], X_5:bat[:oid], X_6:bit, X_7:lng, X_8:bit) (X_9:bat[:oid], X_10:bat[:oid]) LIKEjoin -Join the string bat L with the pattern bat R@with optional candidate lists SL and SR using pattern escape string ESC@and doing a case sensitive match.@The result is two aligned bats with oids of matching rows. +Join the string bat L with the pattern bat R with optional candidate lists SL and SR using pattern escape string ESC and doing a case sensitive match. The result is two aligned bats with oids of matching rows. algebra likejoin command algebra.likejoin(X_0:bat[:str], X_1:bat[:str], X_2:bat[:str], X_3:bat[:bit], X_4:bat[:oid], X_5:bat[:oid], X_6:bit, X_7:lng, X_8:bit):bat[:oid] @@ -3532,7 +3532,7 @@ algebra likeselect command algebra.likeselect(X_0:bat[:str], X_1:bat[:oid], X_2:str, X_3:str, X_4:bit, X_5:bit):bat[:oid] PCRElikeselect -Select all head values of the first input BAT for which the@tail value is "like" the given (SQL-style) pattern and for@which the head value occurs in the tail of the second input@BAT.@Input is a dense-headed BAT, output is a dense-headed BAT with in@the tail the head value of the input BAT for which the@relationship holds. The output BAT is sorted on the tail value. +Select all head values of the first input BAT for which the tail value is "like" the given (SQL-style) pattern and for which the head value occurs in the tail of the second input BAT. Input is a dense-headed BAT, output is a dense-headed BAT with in the tail the head value of the input BAT for which the relationship holds. The output BAT is sorted on the tail value. algebra markjoin command algebra.markjoin(X_0:bat[:any_1], X_1:bat[:any_1], X_2:bat[:oid], X_3:bat[:oid], X_4:bit, X_5:lng) (X_6:bat[:oid], X_7:bat[:bit]) @@ -3612,12 +3612,12 @@ algebra reuse command algebra.reuse(X_0:bat[:any_1]):bat[:any_1] ALGreuse -Reuse a temporary BAT if you can. Otherwise,@allocate enough storage to accept result of an@operation (not involving the heap) +Reuse a temporary BAT if you can. Otherwise, allocate enough storage to accept result of an operation (not involving the heap) algebra select command algebra.select(X_0:bat[:any_1], X_1:any_1, X_2:any_1, X_3:bit, X_4:bit, X_5:bit):bat[:oid] ALGselect1 -Select all head values for which the tail value is in range.@Input is a dense-headed BAT, output is a dense-headed BAT with in@the tail the head value of the input BAT for which the tail value@is between the values low and high (inclusive if li respectively@hi is set). The output BAT is sorted on the tail value. If low@or high is nil, the boundary is not considered (effectively - and@+ infinity). If anti is set, the result is the complement. Nil@values in the tail are never matched, unless low=nil, high=nil,@li=1, hi=1, anti=0. All non-nil values are returned if low=nil,@high=nil, and li, hi are not both 1, or anti=1.@Note that the output is suitable as second input for the other@version of this function. +Select all head values for which the tail value is in range. Input is a dense-headed BAT, output is a dense-headed BAT with in the tail the head value of the input BAT for which the tail value is between the values low and high (inclusive if li respectively hi is set). The output BAT is sorted on the tail value. If low or high is nil, the boundary is not considered (effectively - and + infinity). If anti is set, the result is the complement. Nil values in the tail are never matched, unless low=nil, high=nil, li=1, hi=1, anti=0. All non-nil values are returned if low=nil, high=nil, and li, hi are not both 1, or anti=1. Note that the output is suitable as second input for the other version of this function. algebra select command algebra.select(X_0:bat[:any_1], X_1:any_1, X_2:any_1, X_3:bit, X_4:bit, X_5:bit, X_6:bit):bat[:oid] @@ -3627,7 +3627,7 @@ algebra select command algebra.select(X_0:bat[:any_1], X_1:bat[:oid], X_2:any_1, X_3:any_1, X_4:bit, X_5:bit, X_6:bit):bat[:oid] ALGselect2 -Select all head values of the first input BAT for which the tail value@is in range and for which the head value occurs in the tail of the@second input BAT.@The first input is a dense-headed BAT, the second input is a@dense-headed BAT with sorted tail, output is a dense-headed BAT@with in the tail the head value of the input BAT for which the@tail value is between the values low and high (inclusive if li@respectively hi is set). The output BAT is sorted on the tail@value. If low or high is nil, the boundary is not considered@(effectively - and + infinity). If anti is set, the result is the@complement. Nil values in the tail are never matched, unless@low=nil, high=nil, li=1, hi=1, anti=0. All non-nil values are@returned if low=nil, high=nil, and li, hi are not both 1, or anti=1.@Note that the output is suitable as second input for this@function. +Select all head values of the first input BAT for which the tail value is in range and for which the head value occurs in the tail of the second input BAT. The first input is a dense-headed BAT, the second input is a dense-headed BAT with sorted tail, output is a dense-headed BAT with in the tail the head value of the input BAT for which the tail value is between the values low and high (inclusive if li respectively hi is set). The output BAT is sorted on the tail value. If low or high is nil, the boundary is not considered (effectively - and + infinity). If anti is set, the result is the complement. Nil values in the tail are never matched, unless low=nil, high=nil, li=1, hi=1, anti=0. All non-nil values are returned if low=nil, high=nil, and li, hi are not both 1, or anti=1. Note that the output is suitable as second input for this function. algebra select command algebra.select(X_0:bat[:any_1], X_1:bat[:oid], X_2:any_1, X_3:any_1, X_4:bit, X_5:bit, X_6:bit, X_7:bit):bat[:oid] @@ -3662,47 +3662,47 @@ algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bit, X_2:bit, X_3:bit):bat[:any_1] ALGsort11 -Returns a copy of the BAT sorted on tail values.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bit, X_2:bit, X_3:bit) (X_4:bat[:any_1], X_5:bat[:oid]) ALGsort12 -Returns a copy of the BAT sorted on tail values and a BAT that@specifies how the input was reordered.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values and a BAT that specifies how the input was reordered. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bit, X_2:bit, X_3:bit) (X_4:bat[:any_1], X_5:bat[:oid], X_6:bat[:oid]) ALGsort13 -Returns a copy of the BAT sorted on tail values, a BAT that specifies@how the input was reordered, and a BAT with group information.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values, a BAT that specifies how the input was reordered, and a BAT with group information. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bat[:oid], X_2:bit, X_3:bit, X_4:bit):bat[:any_1] ALGsort21 -Returns a copy of the BAT sorted on tail values.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bat[:oid], X_2:bit, X_3:bit, X_4:bit) (X_5:bat[:any_1], X_6:bat[:oid]) ALGsort22 -Returns a copy of the BAT sorted on tail values and a BAT that@specifies how the input was reordered.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values and a BAT that specifies how the input was reordered. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bat[:oid], X_2:bit, X_3:bit, X_4:bit) (X_5:bat[:any_1], X_6:bat[:oid], X_7:bat[:oid]) ALGsort23 -Returns a copy of the BAT sorted on tail values, a BAT that specifies@how the input was reordered, and a BAT with group information.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values, a BAT that specifies how the input was reordered, and a BAT with group information. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bat[:oid], X_2:bat[:oid], X_3:bit, X_4:bit, X_5:bit):bat[:any_1] ALGsort31 -Returns a copy of the BAT sorted on tail values.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bat[:oid], X_2:bat[:oid], X_3:bit, X_4:bit, X_5:bit) (X_6:bat[:any_1], X_7:bat[:oid]) ALGsort32 -Returns a copy of the BAT sorted on tail values and a BAT that@specifies how the input was reordered.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values and a BAT that specifies how the input was reordered. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra sort command algebra.sort(X_0:bat[:any_1], X_1:bat[:oid], X_2:bat[:oid], X_3:bit, X_4:bit, X_5:bit) (X_6:bat[:any_1], X_7:bat[:oid], X_8:bat[:oid]) ALGsort33 -Returns a copy of the BAT sorted on tail values, a BAT that specifies@how the input was reordered, and a BAT with group information.@The order is descending if the reverse bit is set.@This is a stable sort if the stable bit is set. +Returns a copy of the BAT sorted on tail values, a BAT that specifies how the input was reordered, and a BAT with group information. The order is descending if the reverse bit is set. This is a stable sort if the stable bit is set. algebra subslice command algebra.subslice(X_0:bat[:any_1], X_1:lng, X_2:lng):bat[:oid] @@ -3722,12 +3722,12 @@ algebra thetaselect command algebra.thetaselect(X_0:bat[:any_1], X_1:bat[:oid], X_2:any_1, X_3:str):bat[:oid] ALGthetaselect2 -Select all head values of the first input BAT for which the tail value@obeys the relation value OP VAL and for which the head value occurs in@the tail of the second input BAT.@Input is a dense-headed BAT, output is a dense-headed BAT with in@the tail the head value of the input BAT for which the@relationship holds. The output BAT is sorted on the tail value. +Select all head values of the first input BAT for which the tail value obeys the relation value OP VAL and for which the head value occurs in the tail of the second input BAT. Input is a dense-headed BAT, output is a dense-headed BAT with in the tail the head value of the input BAT for which the relationship holds. The output BAT is sorted on the tail value. algebra unique command algebra.unique(X_0:bat[:any_1], X_1:bat[:oid]):bat[:oid] ALGunique -Select all unique values from the tail of the first input.@Input is a dense-headed BAT, the second input is a@dense-headed BAT with sorted tail, output is a dense-headed@BAT with in the tail the head value of the input BAT that was@selected. The output BAT is sorted on the tail value. The@second input BAT is a list of candidates. +Select all unique values from the tail of the first input. Input is a dense-headed BAT, the second input is a dense-headed BAT with sorted tail, output is a dense-headed BAT with in the tail the head value of the input BAT that was selected. The output BAT is sorted on the tail value. The second input BAT is a list of candidates. bat append command bat.append(X_0:bat[:any_1], X_1:bat[:any_1], X_2:bat[:oid], X_3:bit):bat[:any_1] @@ -3822,7 +3822,7 @@ bat getSize command bat.getSize(X_0:bat[:any_1]):lng BKCgetSize -Calculate the actual size of the BAT descriptor, heaps, hashes in bytes@rounded to the memory page size (see bbp.getPageSize()). +Calculate the actual size of the BAT descriptor, heaps, hashes in bytes rounded to the memory page size (see bbp.getPageSize()). bat getVHeapSize command bat.getVHeapSize(X_0:bat[:any_1]):lng @@ -3842,7 +3842,7 @@ bat info command bat.info(X_0:bat[:any_1]) (X_1:bat[:str], X_2:bat[:str]) BKCinfo -Produce a table containing information about a BAT in [attribute,value] format. @It contains all properties of the BAT record. +Produce a table containing information about a BAT in [attribute,value] format. It contains all properties of the BAT record. bat intersectcand command bat.intersectcand(X_0:bat[:oid], X_1:bat[:oid]):bat[:oid] @@ -3867,7 +3867,7 @@ bat isSynced command bat.isSynced(X_0:bat[:any_1], X_1:bat[:any_2]):bit BKCisSynced -Tests whether two BATs are synced or not. +Tests whether two BATs are synced or not. bat isTransient command bat.isTransient(X_0:bat[:any_1]):bit @@ -3972,7 +3972,7 @@ bat save command bat.save(X_0:str):bit BKCsave -Save a BAT to storage, if it was loaded and dirty. @Returns whether IO was necessary. Please realize that @calling this function violates the atomic commit protocol!! +Save a BAT to storage, if it was loaded and dirty. Returns whether IO was necessary. Please realize that calling this function violates the atomic commit protocol!! bat save command bat.save(X_0:bat[:any_1]):void @@ -3982,7 +3982,7 @@ bat setAccess command bat.setAccess(X_0:bat[:any_1], X_1:str):bat[:any_1] BKCsetAccess -Try to change the update access privileges @to this BAT. Mode:@r[ead-only] - allow only read access.@a[append-only] - allow reads and update.@w[riteable] - allow all operations.@BATs are updatable by default. On making a BAT read-only, @all subsequent updates fail with an error message.@Returns the BAT itself. +Try to change the update access privileges to this BAT. Mode: r[ead-only] - allow only read access. a[append-only] - allow reads and update. w[riteable] - allow all operations. BATs are updatable by default. On making a BAT read-only, all subsequent updates fail with an error message. Returns the BAT itself. bat setHash command bat.setHash(X_0:bat[:any_1]):bit @@ -3992,7 +3992,7 @@ bat setName command bat.setName(X_0:bat[:any_1], X_1:str):void BKCsetName -Give a logical name to a BAT. +Give a logical name to a BAT. bat setPersistent command bat.setPersistent(X_0:bat[:any_1]):void @@ -4002,7 +4002,7 @@ bat setTransient command bat.setTransient(X_0:bat[:any_1]):void BKCsetTransient -Make the BAT transient. Returns @boolean which indicates if the@BAT administration has indeed changed. +Make the BAT transient. Returns boolean which indicates if the BAT administration has indeed changed. bat single pattern bat.single(X_0:any_1):bat[:any_1] @@ -31657,32 +31657,32 @@ batmkey rotate_xor_hash pattern batmkey.rotate_xor_hash(X_0:bat[:lng], X_1:int, X_2:bat[:any]):bat[:lng] MKEYbulk_rotate_xor_hash -pre: h and b should be synced on head@post: [:xor=]([:rotate=](h, nbits), [hash](b)) +pre: h and b should be synced on head post: [:xor=]([:rotate=](h, nbits), [hash](b)) batmkey rotate_xor_hash pattern batmkey.rotate_xor_hash(X_0:bat[:lng], X_1:int, X_2:bat[:any], X_3:bat[:oid], X_4:bat[:oid]):bat[:lng] MKEYbulk_rotate_xor_hash -pre: h and b should be synced on head@post: [:xor=]([:rotate=](h, nbits), [hash](b)), with candidate lists +pre: h and b should be synced on head post: [:xor=]([:rotate=](h, nbits), [hash](b)), with candidate lists batmkey rotate_xor_hash pattern batmkey.rotate_xor_hash(X_0:bat[:lng], X_1:int, X_2:any):bat[:lng] MKEYbulkconst_rotate_xor_hash -pre: h and b should be synced on head@post: [:xor=]([:rotate=](h, nbits), [hash](b)) +pre: h and b should be synced on head post: [:xor=]([:rotate=](h, nbits), [hash](b)) batmkey rotate_xor_hash pattern batmkey.rotate_xor_hash(X_0:bat[:lng], X_1:int, X_2:any, X_3:bat[:oid]):bat[:lng] MKEYbulkconst_rotate_xor_hash -pre: h and b should be synced on head@post: [:xor=]([:rotate=](h, nbits), [hash](b)), with a candidate list +pre: h and b should be synced on head post: [:xor=]([:rotate=](h, nbits), [hash](b)), with a candidate list batmkey rotate_xor_hash pattern batmkey.rotate_xor_hash(X_0:lng, X_1:int, X_2:bat[:any]):bat[:lng] MKEYconstbulk_rotate_xor_hash -pre: h and b should be synced on head@post: [:xor=]([:rotate=](h, nbits), [hash](b)) +pre: h and b should be synced on head post: [:xor=]([:rotate=](h, nbits), [hash](b)) batmkey rotate_xor_hash pattern batmkey.rotate_xor_hash(X_0:lng, X_1:int, X_2:bat[:any], X_3:bat[:oid]):bat[:lng] MKEYconstbulk_rotate_xor_hash -pre: h and b should be synced on head@post: [:xor=]([:rotate=](h, nbits), [hash](b)), with a candidate list +pre: h and b should be synced on head post: [:xor=]([:rotate=](h, nbits), [hash](b)), with a candidate list batmmath acos pattern batmmath.acos(X_0:bat[:dbl]):bat[:dbl] @@ -45292,7 +45292,7 @@ clients quit unsafe pattern clients.quit(X_0:int):void CLTquit -Terminate the session for a single client using a soft error.@It is the privilege of the console user. +Terminate the session for a single client using a soft error. It is the privilege of the console user. clients ripemd160sum command clients.ripemd160sum(X_0:str):str @@ -45302,7 +45302,7 @@ clients setListing unsafe pattern clients.setListing(X_0:int):int CLTsetListing -Turn on/off echo of MAL instructions:@1 - echo input,@2 - show mal instruction,@4 - show details of type resolutoin, @8 - show binding information. +Turn on/off echo of MAL instructions: 1 - echo input, 2 - show mal instruction, 4 - show details of type resolutoin, 8 - show binding information. clients setQryTimeoutMicro unsafe pattern clients.setQryTimeoutMicro(X_0:lng):void @@ -45392,7 +45392,7 @@ clients shutdown unsafe pattern clients.shutdown(X_0:bte, X_1:bit):str CLTshutdown -Close all other client connections. Return if it succeeds.@If forced is set then always stop the system the hard way +Close all other client connections. Return if it succeeds. If forced is set then always stop the system the hard way clients stop unsafe pattern clients.stop(X_0:int):void @@ -45407,7 +45407,7 @@ clients suspend unsafe pattern clients.suspend(X_0:int):void CLTsuspend -Put a client process to sleep for some time.@It will simple sleep for a second at a time, until@the awake bit has been set in its descriptor +Put a client process to sleep for some time. It will simple sleep for a second at a time, until the awake bit has been set in its descriptor clients wakeup unsafe pattern clients.wakeup(X_0:int):void @@ -47247,27 +47247,27 @@ io print pattern io.print(X_0:bat[:any]...):void _______________________________________________ checkin-list mailing list -- [email protected] To unsubscribe send an email to [email protected]
