10. Specific Datatype Modules |
Module String |
constant String.__HAVE_SPRINTF_STAR_MAPPING__
Presence of this symbol indicates that sprintf() supports mappings for the '*'-modifier syntax.
sprintf() , lfun::_sprintf()
constant String.__HAVE_SPRINTF_NEGATIVE_F__
Presence of this symbol indicates that sprintf() supports little endian output for the 'F'-format specifier.
sprintf() , lfun::_sprintf()
string implode_nicely(array(string|int|float) foo, string|void separator)
This function implodes a list of words to a readable string, e.g.
({"straw","berry","pie"})
becomes
"straw, berry and pie"
. If the separator is omitted, the
default is "and"
. If the words are numbers they are
converted to strings first.
`*()
string capitalize(string str)
Convert the first character in str to upper case, and return the new string.
lower_case() , upper_case()
string sillycaps(string str)
Convert the first character in each word (separated by spaces) in str to upper case, and return the new string.
string common_prefix(array(string) strs)
Find the longest common prefix from an array of strings.
int(0..100) fuzzymatch(string a, string b)
This function compares two strings using a fuzzy matching routine. The higher the resulting value, the better the strings match.
Array.diff() , Array.diff_compare_table() Array.diff_longest_sequence()
string soundex(string word)
Returns the soundex value of word according to the original Soundex algorithm, patented by Margaret O´Dell and Robert C. Russel in 1918. The method is based on the phonetic classification of sounds by how they are made. It was only intended for hashing of english surnames, and even at that it isn't that much of a help.
string int2roman(int m)
Converts the provided integer to a roman integer (i.e. a string).
Throws an error if m is outside the range 0 to 10000.
string int2size(int size)
Returns the size as a memory size string with suffix, e.g. 43210 is converted into "42.2 kB". To be correct to the latest standards it should really read "42.2 KiB", but we have chosen to keep the old notation for a while. The function knows about the quantifiers kilo, mega, giga, tera, peta, exa, zetta and yotta.
string expand_tabs(string s, int|void tab_width, string|void substitute_tab, string|void substitute_space, string|void substitute_newline)
Expands tabs in a string to ordinary spaces, according to common tabulation rules.
string int2char(int x)
Same as sprintf("%c",x);
sprintf()
string int2hex(int x)
Same as sprintf("%x",x);
, i.e. returns the integer x in
hexadecimal base using lower cased symbols.
sprintf()
string string2hex(string data)
Convert a string of binary data to a hexadecimal string.
hex2string()
string hex2string(string hex)
Convert a string of hexadecimal digits to binary data.
string2hex()
void secure(string str)
Marks the string as secure, which will clear the memory area before freeing the string.
int count(string haystack, string needle)
Count the number of non-overlapping times the string needle
occurs in the string haystack . The special cases for the needle
""
is that it occurs one time in the empty string, zero
times in a one character string and between every character
(length-1) in any other string.
search() , `/()
string trim_whites(string s)
Trim leading and trailing spaces and tabs from the string s .
string normalize_space(string s, string|void whitespace)
Is returned after white space in it has been normalised. White space is normalised by stripping leading and trailing white space and replacing sequences of white space characters with a single space.
Defines what is considered to be white space eligible for normalisation.
It has a default value that starts with " \t\r\n\v\f"
and in
addition to that contains all whitespace characters part of Unicode.
The first character denotes the character for replacing whitespace
sequences.
Trailing and leading whitespace around \r and \n characters is stripped as well (only useful if they're not in the whitespace set).
This function is a lot faster with just one argument (i.e. the builtin whitespace set has an optimised code path).
string trim_all_whites(string s)
Trim leading and trailing white spaces characters (space, tab, newline, carriage return, form feed, vertical tab and all the white spaces defined in Unicode) from the string s .
int(8..8)|int(16..16)|int(32..32) width(string s)
Returns the width of a string.
Three return values are possible:
|
CLASS String.Iterator |
An object of this class is returned by get_iterator() when called with a string.
get_iterator
inherit predef::Iterator : predef::Iterator
CLASS String.SplitIterator |
An iterator that iterates over substrings of a string, separated by a character or several different characters.
Typically you don't need to explicitly use the SplitIterator. Expressions like the following are automatically optimized into using a SplitIterator.
foreach(str/"\n", string line)
write("%s\n", line);
inherit predef::Iterator : predef::Iterator
void String.SplitIterator(string buffer, int|array(int)|multiset(int) split_set, int|void flags, function(:string)|void feed)
The string to split.
The character or characters to split on.
Skip empty elements if set.
Callback function that is called once the buffer is used up and the SplitIterator wants more data.
CLASS String.Buffer |
A buffer, used for building strings. It's conceptually similar to a string, but you can only add strings to it, and you can only get the value from it once.
There is a reason for those seemingly rather odd limitations, it makes it possible to do some optimizations that really speed things up.
You do not need to use this class unless you add very many strings together, or very large strings.
For the fastest possible operation, write your code like this:
String.Buffer b = String.Buffer( );
function add = b->add;
.. call add several times in code ...
string result = b->get(); // also clears the buffer
void String.Buffer(int initial_size)
Initializes a new buffer.
If no initial_size is specified, 256 is used. If you know approximately how big the buffer will be, you can optimize the operation of add() (slightly) by passing the size to this function.
string _sprintf(int flag, mapping flags)
It is possible to sprintf a String.Buffer object as %s just as if it was a string.
mixed cast(string type)
It is possible to cast a String.Buffer object to
a string
and an int
.
String.Buffer `+(string what)
String.Buffer `+=(string what)
int add(string ... data)
Adds data to the buffer. Returns the size of the buffer.
void putchar(int c)
Appends the character c at the end of the string.
string get_copy()
Get the data from the buffer. Significantly slower than get , but does not clear the buffer.
string get()
Get the data from the buffer.
This will clear the data in the buffer
int _sizeof()
Returns the size of the buffer.
CLASS String.Replace |
This is a "compiled" version of the replace function applied on
a string, with more than one replace string. The replace strings
are given to the create method as a from and to array
and are then analyzed. The `()
is then called with a
string and the replace rules in the Replace object will be
applied. The Replace object is used internally by the Pike
optimizer and need not be used manually.
void String.Replace(array(string)|mapping(string:string)|void from, array(string)|string|void to)
string `()(string str)
array(array(string)) _encode()
void _decode(array(array(string)) encoded)
CLASS String.SingleReplace |
This is a "compiled" version of the replace function applied on
a string, with just one replace string. The replace strings are
given to the create method as a from and tom string and
are then analyzed. The `()
is then called with a string
and the replace rule in the Replace object will be applied. The
Replace object is used internally by the Pike optimizer and need
not be used manually.
void String.SingleReplace(string|void from, string|void to)
May be called with either zero or two arguments.
string `()(string str)
array(string) _encode()
void _decode(array(string)|int(0..0) encoded)
CLASS String.Bootstring |
This class implements the "Bootstring" string transcoder described in ftp://ftp.rfc-editor.org/in-notes/rfc3492.txt.
string decode(string s)
Decodes a Bootstring encoded string of "basic" code points back to the original string space.
string encode(string s)
Encodes a string using Bootstring encoding into a string constisting only of "basic" code points (< initial_n).
void String.Bootstring(int base, int tmin, int tmax, int skew, int damp, int initial_bias, int initial_n, int delim, string digits)
Creates a Bootstring transcoder instance using the specified parameters.
The base used by the variable-length integers.
The minimum threshold digit value for the variable-length integers. Must be >=0 and <= tmax.
The maximum threshold digit value for the variable-length integers. Must be <= base-1.
The skew term for the bias adapation. Must be >= 1.
The damping factor for the bias adaption. Must be >= 2.
The initial bias for the variable-length integer thresholding. initial_bias % base must be <= base - tmin.
The first code point outside the "basic" set of code points.
The "basic" code point used as the delimiter.
The "basic" code points used as digits. The length of the string should be the same as the base parameter.
Module String.Elite |
string elite_word(string in, void|int(0..100) leetp, void|int(0..2) eightbit)
Translates one word to 1337. The optional argument leetp is the maximum percentage of leetness (100=max leet, 0=no leet). elite_word only do character-based translation, for instance from "k" to "|<", but no language translation (no "cool" to "kewl").
string elite_string(string in, void|int(0..100) leetp, void|int(0..1) eightbit)
Translates a string to 1337. The optional argument leetp is the maximum percentage of leetness (100=max leet, 0=no leet).
The translation is performed in three steps, first the neccesary elite translations (picture -> pic, cool->kewl etc), then optional translations (ok->k, dude->dood, -ers -> -orz), then calls elite_word on the resulting words.
Module String.HTML |
Functions that helps generating HTML. All functions generates HTML that is XHTML compliant as well as backwards compatible with old HTML standards in what extent is possible.
string select(string name, array(string)|array(array(string)) choices, void|string selected)
Creates an HTML select list.
The name of the select list. Will be used in the name attribute of the select element.
May either be an array of strings, where each string is a choice, or an array of pairs. A pair is an array with two strings. The first string is the value of the choice while the second string is the presentation text associated with the value.
The value that should be selected by default, if any.
select("language", ({ ({ "eng", "English" }), ({ "swe", "Swedish" }), ({ "nor", "Norwegian" }) }), "swe");
string simple_obox(array(array(string)) rows, void|string frame_color, void|string cell_color, void|string width, void|string padding, void|function(int:string) cell_callback)
This function should solve most of the obox needs that arises. It creates a table out of the array of arrays of strings fed into it. The tables will (with default settings) have a thin black outline around the table and between its cells. Much effort has gone into finding a simple HTML reresentation of such obox that is rendered in a similar way in all popular browsers. The current implementation has been tested against IE, Netscape, Mozilla, Opera and Konquest.
Simply an array of arrays with strings. The strings are the values that should appear in the table cells. All rows should have equal number of cells, otherwise the result will not be very eye pleasing.
The color of the surrounding frame. Defaults to "#000000".
The background color of the cells. Defaults to "#ffffff".
The border width. Defaults to "1".
The amount of padding in each cell. Defaults to "3".
If provided, the cell callback will be called for each cell. As in parameters it will get the current x and y coordinates in the table. The upper left cell is 0,0. In addition to the coordinates it will also receive the background color and the contents of the current cell. It is expected to return a td-element.
function cb = lambda(int x, int y, string bgcolor, string contents) { if(y%2) return "<td bgcolor='#aaaaff'>"+contents+"</td>"; return "<td bgcolor='"+bgcolor+"'>"+contents+"</td>"; } simple_obox(my_rows, "#0000a0", 0, "1", "3", cb);
pad_rows
array(array(string)) pad_rows(array(array(string)) rows, void|string padding)
Pads out the rows in a array of rows to equal length. The new elements in the rows will have the value provided in padding , or " ".
CLASS String.HTML.OBox |
Provides the same functionality as the simple_obox function, in a "streaming" way. The real gain is different addtition methods as well as the possibility to change the cell callback at any time.
simple_obox
void String.HTML.OBox(void|string frame_color, void|string cell_color, void|string width, void|string padding, void|function(int:string) cell_callback)
void set_cell_callback(function(int:string) cell_callback)
void set_extra_args(mapping(string:string) extra_args)
The argument in the mapping will be added to all created table cells.
void set_extra_args(array(mapping(string:string)) extra_args)
The argument in the mappings will be added to the cell in the cooresponding column of the table.
void add_raw_cell(string cell)
Adds this cell to the table unmodified, e.g. it should have an enclosing td or th element.
void add_tagdata_cell(string tag, mapping(string:string) args, string contents)
Creates a cell from the provided arguments and adds it to the table.
The name of the element that should be produces. Typically "td" or "th".
A mapping with the elements attributes.
The element contents.
void add_cell(string contents)
Adds a cell with the provided content.
void new_row()
Begin a new row. Succeeding cells will be added to this row instead of the current.
void add_row(array(string) cells)
Adds a complete row. If the current row is nonempty a new row will be started.
void pad_rows()
Ensures that all rows have the same number of cells.
string render()
Returns the result.
mixed cast(string to)
It is possible to case this object to a string, which does the same as calling render , and to an array, which returns the cells in an array of rows.
Module Array |
General functions to operate on arrays.
array(int) interleave_array(array(mapping(int:mixed)) tab)
Interleave a sparse matrix.
Returns an array with offsets that describe how to shift the rows of tab so that only at most one non-zero value exists in every column.
array(int) longest_ordered_sequence(array a)
Find the longest ordered sequence of elements.
This function returns an array of the indices in the longest ordered sequence of elements in the array.
diff()
array permute(array in, int number)
Give a specified permutation of an array.
The number of permutations is equal to sizeof(in )!
(the factorial of the size of the given array).
shuffle()
array(array(array)) diff(array a, array b)
Calculates which parts of the arrays that are common to both, and which parts that are not.
Returns an array with two elements, the first is an array of parts in array a , and the second is an array of parts in array b .
diff_compare_table() , diff_longest_sequence() , String.fuzzymatch()
array(array(int)) diff_compare_table(array a, array b)
Returns an array which maps from index in a to corresponding indices in b .
> Array.diff_compare_table( ({ "a","b","c" }), ({ "b", "b", "c", "d", "b" }));
Result: ({
({ }),
({
0,
1,
4
}),
({
2
})
})
diff() , diff_longest_sequence() , String.fuzzymatch()
array(int) diff_longest_sequence(array a, array b)
Gives the longest sequence of indices in b that have corresponding values in the same order in a .
diff() , diff_compare_table() , String.fuzzymatch()
array(int) diff_dyn_longest_sequence(array a, array b)
Gives the longest sequence of indices in b that have corresponding values in the same order in a .
This function performs the same operation as diff_longest_sequence() , but uses a different algorithm, which in some rare cases might be faster (usually it's slower though).
diff_longest_sequence() , diff() , diff_compare_table() , String.fuzzymatch()
array uniq(array a)
Remove elements that are duplicates.
This function returns an copy of the array a with all duplicate values removed. The order of the values is kept in the result; it's always the first of several equal elements that is kept.
Elements are compared with `== . They are also hashed (see lfun::__hash for further details if the array contains objects).
array(mixed) splice(array(mixed) arr1, array(mixed) arr2, array(mixed) ... more_arrays)
Splice two or more arrays.
This means that the returned array has the first element in the first given array, then the first argument in next array and so on for all arrays. Then the second elements are added, etc.
`/() , `*() , `+() , `-() , everynth()
array(mixed) everynth(array(mixed) a, void|int n, void|int start)
Return an array with every n :th element of the array a .
If n is zero every other element will be returned.
splice() , `/()
array(array) transpose(array(array) matrix)
Takes an array of equally sized arrays (essentially a matrix of size M*N) and returns the transposed (N*M) version of it, where rows and columns are exchanged for one another.
mixed reduce(function fun, array arr, mixed|void zero)
reduce() sends the first two elements in arr to fun , then the result and the next element in arr to fun and so on. Then it returns the result. The function will return zero if arr is the empty array. If arr has only one element, that element will be returned.
rreduce()
mixed rreduce(function fun, array arr, mixed|void zero)
rreduce() sends the last two elements in arr to fun , then the third last element in arr and the result to fun and so on. Then it returns the result. The function will return zero if arr is the empty array. If arr has only one element, that element will be returned.
reduce()
array shuffle(array arr)
shuffle() gives back the same elements, but in random order. The array is modified destructively.
permute()
array(array) combinations(array arr, int len)
Returns an array of all combinations of length len of elements from arr .
permute()
int search_array(array arr, string|function|int fun, mixed ... args)
search_array() works like map() , only it returns the index of the first call that returnes true instead.
If no call returns true, -1 is returned.
sum() , map()
array sum_arrays(function(int(0..0) ... :mixed) sum, array ... args)
Applies the function sum columnwise on the elements in the
provided arrays. E.g. sum_array(`+,a,b,c)
does the same
as `+(a[*],b[*],c[*])
.
array sort_array(array arr, function|void cmp, mixed ... args)
This function sorts the array arr after a compare-function
cmp which takes two arguments and should return 1
if the
first argument is larger then the second. Returns the sorted array
- arr is not sorted destructively.
The remaining arguments args will be sent as 3rd, 4th etc. argument to cmp .
If cmp is omitted, `>() is used instead.
map() , sort() , `>() , dwim_sort_func , lyskom_sort_func , oid_sort_func
array(array) columns(array x, array ind)
Get multiple columns from an array.
This function is equvivalent to
map(ind, lambda(mixed i) { return column(x, i); })
column()
array(array(array)) diff3(array a, array b, array c)
Return the three-way difference between the arrays.
Array.diff() , Array.diff_longest_sequence()
array(array(array)) compact_diff3(array a, array b, array old)
Given three arrays like those returned from diff3 , this function "compacts" the diff3 result by removing all differences where a and b agrees against old. The result is on the same form as the result from diff , and doesn't include the sequence from old.
int(-1..1) dwim_sort_func(string a, string b)
Sort without respect to number formatting (most notably leading zeroes).
int(-1..1) lyskom_sort_func(string a, string b)
Sort comparison function that does not care about case, nor about the contents of any parts of the string enclosed with '()'
Example: "Foo (bar)" is given the same weight as "foo (really!)"
array flatten(array a, mapping(array:array)|void state)
Flatten a multi-dimensional array to a one-dimensional array.
Prior to Pike 7.5.7 it was not safe to call this function with cyclic data-structures.
mixed sum(array a)
Sum the elements of an array using `+. The empty array results in 0.
array uniq2(array a)
Perform the same action as the Unix uniq command on an array, that is, fold consecutive occurrences of the same element into a single element of the result array:
aabbbcaababb -> abcabab.
See also the uniq function.
array arrayify(void|array|mixed x)
Make an array of the argument, if it isn't already. A zero_type argument gives the empty array. This is useful when something is either an array or a basic datatype, for instance in headers from the MIME module or Protocols.HTTP.Server.
Result depends of the argument type:
arrayify(x) => x
arrayify(x) => ({})
arrayify(x) => ({ x })
int(-1..1) oid_sort_func(string a, string b)
Sort with care of numerical sort for OID values, e.g. "1.2.1" before "1.11.1".
|
In Pike 7.6 and older this function returned 0
both when
a<b
and a==b
.
sort_array
array(array(array)) greedy_diff(array from, array to)
Like Array.diff , but tries to generate bigger continuous chunks of the
differences, instead of maximizing the number of difference chunks. More
specifically, greedy_diff optimizes the cases where Array.diff returns
({ ..., A, Z, B, ({}), C, ... })
({ ..., A, X, B, Y+B, C, ... })
into the somewhat shorter diff arrays
({ ..., A, Z, B+C, ... })
({ ..., A, X+B+Y, B+C, ... })
int count(array|mapping|multiset haystack, mixed needle)
mapping(mixed:int) count(array|mapping|multiset haystack)
Returns the number of occurrences of needle in haystack . If the optional needle argument is omitted, count instead works similar to the unix command sort|uniq -c, returning a mapping with the number of occurrences of each element in haystack . For array or mapping haystack s, it's the values that are counted, for multisets the indices, as you'd expect.
String.count , search , has_value
array common_prefix(array(array) arrs)
Find the longest common prefix from an array of arrays.
String.common_prefix
int(0..1) all(array a, function(int(0..0):mixed) predicate, mixed ... extra_args)
Returns 1 if all of the elements in a fulfills the requirement predicate ( a [i], @extra_args ), otherwise 0. The predicate should return non-zero for an element that meets the requirements and zero for those that do not.
Array.all( ({ 2, 4, 6, 8 }), `<, 17 )
any , has_value
int(0..1) any(array a, function(int(0..0):mixed) predicate, mixed ... extra_args)
Returns 1 if any of the elements in a fulfills the requirement predicate ( a [i], @extra_args ), otherwise 0. The predicate should return non-zero for an element that meets the requirements and zero for those that do not.
Array.any( ({ 2, 4, 6, 8 }), `>, 5 )
all , has_value
array(array) partition(array a, function(int(0..0):mixed) arbiter, mixed ... extra_args)
Splits an array in two, according to an arbitration function arbiter . The elements in a who return non-zero for the expression arbiter ( a [i], @extra_args ) end up in the first sub-array, the others in the second. The order is preserved from the original array.
Array.partition( enumerate( 9 ), lambda(int n) { return n>3 && n<7; } ); > ({ ({ 4, 5, 6 }), ({ 0, 1, 2, 3, 7, 8 }) })
filter , `/ , `%
array push(array list, mixed element)
Threats an Array as a stack and pushes the element onto the end.
Array.push(({ "a", "b", "c", "d" }), "e"); > ({ "a", "b", "c", "d", "e" })
ADT.Stack , ADT.Stack.push
array pop(array list)
Pops and returns the last value of the array, shortening the array by one element. If there are no elements in the array then 0 is returned otherwise an array is returned where the first returned element is the popped value, and the second element is the modified array.
Array.pop(({ "a", "b", "c", "d" })); > ({ "d", ({ "a", "b", "c" }) })
ADT.Stack , ADT.Stack.pop , ADT.Stack.quick_pop
array shift(array list)
Shifts the first value of the array off and returns it, shortening the array by 1 and moving everything down. If there are no elements in the array it returns 0. Returns an array where the first element is the shifted value and the second element is the modified array.
Array.shift(({ "a", "b", "c", "d"})); > ({ "a", ({ "b", "c", "d" }) })
ADT.Stack
array unshift(array list, mixed element)
Does the opposite of "shift". Or the opposite of a "push", depending on how you look at it. Prepends the element to the front of the array and returns the new array.
Array.unshift(({ "b", "c", "d" }), "a"); > ({ "a", "b", "c", "d" })
ADT.Stack
CLASS Array.Iterator |
An object of this class is returned by get_iterator() when called with an array.
get_iterator
inherit predef::Iterator : predef::Iterator
Module Function |
string defined(function fun)
Returns a string with filename and linenumber where fun was defined.
Returns 0
(zero) when no line can be found, e.g. for
builtin functions and functions in destructed objects.
mixed splice_call(array args, function f, mixed|void ... extra)
Calls the given function with the args array plus the optional extra arguments as its arguments and returns the result.
Most useful in conjunction with map , and particularly in combination
with sscanf with "...%{...%}..."
scan strings (which indeed
was what it was invented for in the first place).
The first arguments the function f expects.
The function to apply the arguments on.
Optional extra arguments to send to f .
Whatever the supplied function f returns.
class Product(string name, string version) { string _sprintf() { return sprintf("Product(%s/%s)", name, version); } } map(({ ({ "pike", "7.1.11" }), ({ "whitefish", "0.1" }) }), Function.splice_call, Product); ({ /* 2 elements */ Product(pike/7.1.11), Product(whitefish/0.1) })
function Y(function f)
The dreaded fixpoint combinator "Y".
The Y combinator is useful when writing recursive lambdas. It converts a lambda that expects a self-reference as its first argument into one which can be called without this argument.
This example creates a lambda that computes the faculty function.
Function.Y(lambda(function f, int n) { return n>1? n*f(n-1) : 1; })
function curry(function f)
Partially evaluate a function call.
This function allows N parameters to be given to a function taking M parameters (N<=M), yielding a new function taking M-N parameters.
What is actually returned from this function is a function taking N parameters, and returning a function taking M-N parameters.
This example creates a function adding 7 to its argument.
Function.curry(`+)(7)
void call_callback(function f, mixed ... args)
Call a callback function, but send throws from the callback function (ie, errors) to master()->handle_error. Also accepts if f is zero (0) without error.
Functions.call_callback(the_callback,some,arguments);
equals
{ mixed err=catch { if (the_callback) the_callback(some,arguments); }; if (err) master()->handle_error(err); }
(Approximately, since call_callback also calls handle_error if 0 were thrown.)
Module Program |
array(program) inherit_list(program p)
Returns an array with the programs that p has inherited.
array(program) all_inherits(program p)
Document this function.
array inherit_tree(program p)
Recursively builds a inheritance tree by fetching programs inheritance lists.
Returns an array with programs or arrays as elements.
> class a{} > class b{} > class c{ inherit a; } > class d{ inherit b; inherit c; } > Program.inherit_tree(d); Result: ({ /* 3 elements */ d, ({ /* 1 element */ program }), ({ /* 2 elements */ c, ({ /* 1 element */ program }) }) })
int implements(program prog, program api)
Returns 1 if prog implements api .
int inherits(program child, program parent)
Returns 1 if child has inherited parent .
string defined(program p)
Returns a string with filename and linenumber describing where the program p was defined.
The returned string is of the format "filename:linenumber"
.
If it cannot be determined where the program was defined, 0
(zero) will be returned.
Module ADT |
Various Abstract Data Types.
inherit _ADT : _ADT
CLASS ADT.CircularList |
This is an circular list implemented by an array. It has a constant time complexity for pop and push. It has a limited max size but it can be increased with the method allocate.
mixed `[](int index)
Index operator
The index to get the value for, could be negative to index from the end.
The value at the index index
An error if the index is out of range.
mixed `[]=(int index, mixed value)
Index assign operator. Set the value at the index index to be value
The index to set
The new value
The new value at the index index
An error if the index is out of range.
CircularList `+(CircularList ... coll)
Addition operator
Append the content of this CircularList and @coll and return the results as a new CircularList .
The lists to append to this list
The result of the append as a new CircularList .
int(0..1) _equal(mixed coll)
Returns true if the object coll is a CircularList and contains the same values in the same order.
array _indices()
The indices in this list as an array.
void _insert_element(int index, mixed value)
Insert an element in the list at the position index , the value at the position index and all above will have their index increased by one.
The index to insert the value at.
The new value.
An error if the index is out of range.
mixed _remove_element(int index)
Remove the values at index index from the list.
The index to remove.
The removed value.
An error if the index is out of range.
int _search(mixed value, void|int start)
Search the list for a specific value. Return the index of the first
value that is equal to value . If no value was found UNDEFINED
is returned instead
The value to find
If a start value is supplied it will start searching at the index start .
Returns the index of the found value or UNDEFINED
.
An error if the start is out of range.
int _sizeof()
The number of elements in this list.
array _values()
The values in this list as an array.
void add(mixed value)
Add a value at the front of the list
The value to add.
An error if the list is full.
void allocate(int elements)
Increase the maxsize of the CircularlList.
Add this number of new elements to the list.
mixed cast(string type)
Cast operator.
Casts to this type.
Casts to the following types are supported:
|
An array with the contents of this list.
void clear()
Clear the contents of the list.
int delete_value(mixed value)
Remove the first occurrence of the value value from the list.
The value to remove from the list.
The index of the removed element or -1 if there was no value to remove.
int(0..1) is_empty()
Returns 1
if the list is empty otherwise 0
.
int max_size()
Returns the maximal size of this list.
mixed peek_back()
The value at the back of the list but do not remove it from the list.
mixed peek_front()
The value at the front of the list but do not remove it from the list.
mixed pop_back()
Remove the value at the back of the list and return it.
The value at the back of the list.
mixed pop_front()
Remove the value at the front of the list and return it.
The value at the front of the list.
void push_back(mixed value)
Add a new value at the end of the list.
The value to add.
void push_front(mixed value)
Add a new value at the end of the list.
The value to add.
void ADT.CircularList(array|int arg)
Creates a new CircularList around the array arg or a new CircularList with the maximum size of arg.
CircularListIterator _get_iterator(void|int ind)
Create and initiate a new CircularListIterator that could be used to iterate over this list.
If an ind value is supplied the iterator will be positioned at that index.
An iterator.
CircularListIterator first()
Create and initiate a new CircularListIterator that could be used to iterate over this list.
An iterator positioned at the first element in the list.
CircularListIterator last()
Create and initiate a new CircularListIterator that could be used to iterate over this list.
An iterator positioned after the last element in the list.
CLASS ADT.CircularList.CircularListIterator |
This is the iterator for the CircularList. It implements the IndexIterator and the OutputIterator.
void ADT.CircularList.CircularListIterator(object list, void|int start)
Creates a new iterator for the CircularList list . If start is supplied it will try to position the iterator at start .
int index()
The index at the current position.
mixed value()
The value at the current position.
CircularListIterator `+(int steps)
Move the iterator steps steps forward (negative value on steps will cause the iterator to move backwards) and return the result as a new iterator.
A new iterator positioned steps steps forward.
CircularListIterator `+=(int steps)
Move this iterator steps steps forward (negative value on steps will cause the iterator to move backwards) and return the result.
This iterator positioned steps steps forward.
CircularListIterator `-(int steps)
Move the iterator steps steps backwards (negative value on steps will cause the iterator to move forwards) and return the result as a new iterator.
A new iterator positioned steps steps backwards.
int(0..1) has_next(void|int steps)
Returns true if it is possible to move steps steps forwards, if steps weren't supplied it check if it is possible to move one step forward.
int(0..1) has_previous(void|int steps)
Returns true if it is possible to move steps steps backwards, if steps weren't supplied it check if it is possible to move one step backward.
int(0..1) `!()
Returns false if the iterator has reached the end.
int(0..1) _equal(mixed iter)
Compare this iterator with another iterator.
The iterator to compare with
Returns true if both iterators iterates over the same objects and are positioned at the same spot.
int(0..1) `<(mixed iter)
Less then operator
Returns true if this iterator has a lower index then iter .
int(0..1) `>(mixed iter)
Greater then operator
Returns true if this iterator has a higher index then iter .
int distance(object iter)
The iterator to measure the distance to.
Returns distance between this iterator and iter .
An error if the two iterator could not be compared.
CircularList get_collection()
Returns the CircularList this iterator currently iterates over.
mixed set_value(mixed val)
Set the value at the current position.
The new value
Returns the old value
CLASS ADT.Sequence |
The sequence work similar to an array but has the possibilities to insert and remove elements. It also has a more powerful iterator.
mixed `[](int index)
Index operator.
The index to get the value for, could be negative to index from the end.
The value at the index index .
An error if the index is out of range.
mixed `[]=(int index, mixed value)
Index assign operator. Set the value at the index index to be value .
The index to set.
The new value.
The new value at the index index .
Sequence `+(Sequence ... coll)
Addition operator
Append the content of @coll to this sequence and return the results as a new Sequence .
The sequences to append to this sequence.
The result of the append as a new Sequence .
Sequence `-(Sequence ... coll)
Subtraction operator
Removes those values in this sequence that also are present in @coll and return the results as a new Sequence .
The sequence to subtract from this sequence.
The result of the subtraction as a new Sequence .
Sequence `&(Sequence coll)
And operator Perform an and on this sequence and the coll sequence by only returning those values that is present in both sequences as a new Sequence . The remaining values is in the same order as they are in this sequence and the values are compared using `==.
The sequence to and to this sequence.
The result of the and as a new Sequence .
Sequence `|(Sequence coll)
Or operator Perform an or on this sequence and the coll sequence by returning those values that is present in both sequences as a new Sequence . The values are compared using `==.
The sequence to or with this sequence.
The result of the or as a new Sequence .
Sequence `^(Sequence coll)
Xor operator Perform a xor on this sequence and the coll sequence by returning those values that is present in one of the sequences but not in both adapters as a new Sequence . The values are compared using `==.
The sequence to xor with this sequence.
The result of the xor as a new Sequence .
int(0..1) _equal(mixed coll)
Returns true if the object coll is a Sequence and contains the same values in the same order.
array _indices()
The indices in this adapter as an array.
void _insert_element(int index, mixed value)
Insert an element in the sequence at the position index , the value at the position index and all above will have their index increased by one.
The index to insert the value at.
The new value.
mixed _remove_element(int index)
Remove the values at index index from the sequence.
The index to remove.
The removed value.
int _search(mixed value, void|int start)
Search the sequence for a specific value. Return the index of the first
value that is equal to value . If no value was found UNDEFINED
is returned instead.
The value to find.
If a start value is supplied it will start searching at the index start .
Returns the index of the found value or UNDEFINED
.
int _sizeof()
The number of elements in this adapter.
array _values()
The values in this adapter as an array.
void add(mixed value)
Add a value at the end of the sequence.
The value to add.
mixed cast(string type)
Cast operator.
Casts to this type.
Casts to the following types are supported:
|
An array with the contents of this sequence.
void clear()
Clear the contents of the sequence.
int delete_value(mixed value)
Remove the first occurrence of the value value from the sequence.
The value to remove from the sequence.
The index of the removed element or -1 if there was no value to remove.
int(0..1) is_empty()
Returns 1
if the sequence is empty otherwise 0
.
int max_size()
Returns -1.
void ADT.Sequence(array|int arg)
Creates a new Sequence around the array arg or a new Sequence with the size of arg.
SequenceIterator _get_iterator(void|int ind)
Create and initiate a new SequenceIterator that could be used to iterate over this sequence.
If an ind value is supplied the iterator will be positioned at that index.
An iterator.
SequenceIterator first()
Create and initiate a new SequenceIterator that could be used to iterate over this sequence.
An iterator positioned at the first element in the sequence.
SequenceIterator last()
Create and initiate a new SequenceIterator that could be used to iterate over this sequence.
An iterator positioned after the last element in the sequence.
CLASS ADT.Sequence.SequenceIterator |
This is the iterator for the Sequence. It implements the IndexIterator and the OutputIterator
void ADT.Sequence.SequenceIterator(object sequence, void|int start)
Creates a new iterator for the sequence sequence . If start is supplied it will try to position the iterator at start .
int index()
The index at the current position.
mixed value()
The value at the current position.
SequenceIterator `+(int steps)
Move the iterator steps steps forward (negative value on steps will cause the iterator to move backwards) and return the result as a new iterator.
A new iterator positioned steps steps forward.
SequenceIterator `+=(int steps)
Move this iterator steps steps forward (negative value on steps will cause the iterator to move backwards) and return the result.
This iterator positioned steps steps forward.
SequenceIterator `-(int steps)
Move the iterator steps steps backwards (negative value on steps will cause the iterator to move forwards) and return the result as a new iterator.
A new iterator positioned steps steps backwards.
int(0..1) has_next(void|int steps)
Returns true if it is possible to move steps steps forwards, if steps weren't supplied it check if it is possible to move one step forward.
int(0..1) has_previous(void|int steps)
Returns true if it is possible to move steps steps backwards, if steps weren't supplied it check if it is possible to move one step backward.
int(0..1) `!()
Returns false if the iterator has reached the end.
int(0..1) _equal(mixed iter)
Compare this iterator with another iterator.
The iterator to compare with.
Returns true if both iterators iterates over the same objects and are positioned at the same spot.
int(0..1) `<(mixed iter)
Less then operator.
Returns true if this iterator has a lower index then iter .
int(0..1) `>(mixed iter)
Greater then operator.
Returns true if this iterator has a higher index then iter .
int distance(object iter)
The iterator to measure the distance to.
Returns distance between this iterator and iter .
An error if the two iterator could not be compared.
Sequence get_collection()
Returns the Sequence this iterator currently iterates over.
mixed set_value(mixed val)
Set the value at the current position.
The new value.
Returns the old value.
CLASS ADT.List |
Linked list of values.
int(0..1) is_empty()
Check if the list is empty.
Returns 1
if the list is empty,
and 0
(zero) if there are elements in the list.
int(0..) _sizeof()
Returns the number of elements in the list.
string _sprintf(int c, mapping(string:mixed)|void attr)
Describe the list.
sprintf() , lfun::_sprintf()
mixed head()
Get the element at the head of the list.
Throws an error if the list is empty.
is_empty() , tail() , pop()
mixed tail()
Get the element at the tail of the list.
Throws an error if the list is empty.
is_empty() , head() , pop()
mixed pop()
Pop the element at the head of the list from the list.
Throws an error if the list is empty.
is_empty() , head() , tail()
void append(mixed ... values)
Append values to the end of the list.
insert()
void insert(mixed ... values)
Insert values at the front of the list.
append()
void ADT.List(mixed ... values)
Create a new List , and initialize it with values .
Ought to reset the List if called multiple times.
CLASS ADT.List._get_iterator |
Iterator that loops over the List .
mixed value()
Returns the value at the current position.
int(0..1) first()
Reset the iterator to point to the first element in the list.
Returns 1
if there are elements in the list,
and 0
(zero) if the list is empty.
int(0..1) next()
Advance to the next element in the list.
Returns 1
on success, and 0
(zero)
at the end of the list.
prev()
int(0..1) prev()
Retrace to the previous element in the list.
Returns 1
on success, and 0
(zero)
at the beginning of the list.
next()
Iterator `+=(int steps)
Advance or retrace the specified number of steps .
next() , prev
void insert(mixed val)
Insert val at the current position.
append() , delete() , set()
void append(mixed val)
Append val after the current position.
insert() , delete() , set()
void delete()
Delete the current node.
The current position will advance to the next node. This function thus performes the reverse operation of insert() .
insert() , append() , set()
void set(mixed val)
Set the value of the current position to val .
insert() , append() , delete()
CLASS ADT.Stack |
This class implements a simple stack. Instead of adding and removing elements to an array, and thus making it vary in size for every push and pop operation, this stack tries to keep the stack size constant. If however the stack risks to overflow, it will allocate double its current size, i.e. pushing an element on an full 32 slot stack will result in a 64 slot stack with 33 elements.
void push(mixed val)
Push an element on the top of the stack.
mixed top()
Returns the top element from the stack, without popping it.
Throws an error if called on an empty stack.
void quick_pop(void|int val)
Pops val entries from the stack, or one entry if no value is given. The popped entries are not actually freed, only the stack pointer is moved.
mixed pop(void|int val)
Pops and returns entry val from the stack, counting from the top. If no value is given the top element is popped and returned. All popped entries are freed from the stack.
void reset(int|void initial_size)
Empties the stack, resets the stack pointer and shrinks the stack size to the given value or 32 if none is given.
create
void ADT.Stack(int|void initial_size)
An initial stack size can be given when a stack is cloned. The default value is 32.
void set_stack(array stack)
Sets the stacks content to the provided array.
int _sizeof()
sizeof on a stack returns the number of entries in the stack.
array _values()
values on a stack returns all the entries in the stack, in order.
this_program `+(this_program s)
A stack added with another stack yields a third a third stack will all the stack elements from the two first stacks.
CLASS ADT.Set |
ADT.Set implements a datatype for sets. These sets behave much like multisets, except that they are restricted to containing only one instance of each member value.
From a performance viewpoint, it is probably more efficient for a Pike program to use mappings to serve as sets, rather than using an ADT.Set,so ADT.Set is mainly provided for the sake of completeness and code readability.
void reset()
Remove all items from the set.
void add(mixed ... items)
Add items to the set.
void remove(mixed ... items)
Remove items from the set.
int(0..1) contains(mixed item)
Check whether a value is a member of the set.
int(0..1) is_empty()
Returns 1 if the set is empty, otherwise 0.
array(mixed) map(function f)
Map the values of a set: calls the map function f once for each member of the set, returning an array which contains the result of each one of those function calls. Note that since a set isn't ordered, the values in the returned array will be in more or less random order. If you need to know which member value produced which result, you have to make that a part of what the filtering function returns.
The filtering function f is called with a single, mixed-type argument which is the member value to be mapped.
this_program filter(function f)
Return a filtered version of the set, containing only those members for which the filtering function f returned true.
The filtering function is called with a single mixed-type argument which is the member value to be checked.
this_program filter_destructively(function f)
Destructively filter the set, i.e. remove every element for which the filtering function f returns 0, and then return the set.
The filtering function is called with a single mixed-type argument which is the member value to be checked.
int(0..1) subset(ADT.Set other)
Subset. A <= B returns true if all items in A are also present in B.
int(0..1) superset(ADT.Set other)
Superset. A >= B returns true if all items in B are also present in A.
int(0..1) `==(ADT.Set other)
Equality. A == B returns true if all items in A are present in B, and all items in B are present in A. Otherwise, it returns false.
int(0..1) `<(ADT.Set other)
True subset. A < B returns true if each item in A is also present in B, and B contains at least one item not present in A.
int(0..1) `>(ADT.Set other)
True superset. A > B returns true if each item in B is also present in A, and A contains at least one item not present in B.
function ADT.Set.`<=
Subset operator.
function ADT.Set.`>=
Superset operator.
int(0..1) `!=(ADT.Set other)
Inequality. A != B is equivalent to !(A == B).
this_program `|(ADT.Set other)
Union. Returns a set containing all elements present in either or both of the operand sets.
this_program `&(ADT.Set other)
Intersection. Returns a set containing those values that were present in both the operand sets.
this_program `-(ADT.Set other)
Difference. The expression 'A - B', where A and B are sets, returns all elements in A that are not also present in B.
int(0..1) `[](mixed item)
Indexing a set with a value V gives 1 if V is a member of the set, otherwise 0.
int `[]=(mixed item, int value)
Setting an index V to 0 removes V from the set. Setting it to a non-0 value adds V as a member of the set.
array(mixed) _indices()
In analogy with multisets, indices() of an ADT.Set givess an array containing all members of the set.
array(mixed) _values()
In analogy with multisets, values() of an ADT.Set givess an array indicating the number of occurrences in the set for each position in the member array returned by indices(). (Most of the time, this is probably rather useless for sets, since the result is an array which just contain 1's, one for each member of the set. Still, this function is provided for consistency.
mixed cast(string to)
An ADT.Set can be cast to an array or a multiset.
int _sizeof()
Number of items in the set.
string _sprintf(int t)
Printable representation of the set.
void ADT.Set(void|ADT.Set|array|multiset|mapping initial_data)
Create an ADT.Set, optionally initialized from another ADT.Set or a compatible type. If no initial data is given, the set will start out empty.
CLASS ADT.Priority_queue |
This class implements a priority queue. Each element in the priority queue is assigned a priority value, and the priority queue always remains sorted in increasing order of the priority values. The top of the priority queue always holds the element with the smallest priority. The priority queue is realized as a (min-)heap.
inherit .Heap : Heap
mixed push(int pri, mixed val)
Push an element val into the priority queue and assign a priority value pri to it. The priority queue will automatically sort itself so that the element with the smallest priority will be at the top.
void adjust_pri(mixed handle, int new_pri)
Adjust the priority value new_pri of an element handle in the priority queue. The priority queue will automatically sort itself so that the element with the smallest priority value will be at the top.
mixed pop()
Removes and returns the item on top of the heap, which also is the smallest value in the heap.
mixed peek()
Returns the item on top of the priority queue (which is also the element with the smallest priority value) without removing it.
CLASS ADT.Heap |
This class implements a (min-)heap. The value of a child node will always be greater than or equal to the value of its parent node. Thus, the top node of the heap will always hold the smallest value.
void push(mixed value)
Push an element onto the heap. The heap will automatically sort itself so that the smallest value will be at the top.
void adjust(mixed value)
Takes a value in the heap and sorts it through the heap to maintain its sort criteria (increasing order).
mixed pop()
Removes and returns the item on top of the heap, which also is the smallest value in the heap.
int _sizeof()
Returns the number of elements in the heap.
__deprecated__ mixed top()
Removes and returns the item on top of the heap, which also is the smallest value in the heap.
__deprecated__ int size()
Returns the number of elements in the heap.
mixed peek()
Returns the item on top of the heap (which is also the smallest value in the heap) without removing it.
CLASS ADT.History |
A history is a stack where you can only push entries. When the stack has reached a certain size the oldest entries are removed on every push. Other proposed names for this data type is leaking stack and table (where you push objects onto the table in one end and objects are falling off the table in the other.
void ADT.History(int max_size)
max_size is the maximum number of entries that can reside in the history at the same time.
void set_no_adjacent_duplicates(int(0..1) i)
Change how the History object should treat two identical values in a row. If 1 than only unique values are allowed after each other.
query_no_adjacent_duplicates
int(0..1) query_no_adjacent_duplicates()
Tells if the History object allows adjacent equal values. 1 means that only uniqe values are allowed adter each other.
set_no_adjacent_duplicates
void push(mixed value)
Push a new value into the history.
int _sizeof()
A sizeof operation on this object returns the number of elements currently in the history, e.g. <= the current max size.
int get_maxsize()
Returns the maximum number of values in the history
set_maxsize
int get_latest_entry_num()
Returns the absolute sequence number of the latest result inserted into the history.
int get_first_entry_num()
Returns the absolute sequence number of the oldest result still in the history. Returns 0 if there are no results in the history.
mixed `[](int i)
Get a value from the history as if it was an array, e.g. both positive and negative numbers may be used. The positive numbers are however offset with 1, so [1] is the first entry in the history and [-1] is the last.
void `[]=(int i, mixed value)
Overwrite one value in the history. The history position may be identified either by positive or negative offset, like `[] .
void set_maxsize(int _maxsize)
Set the maximume number of entries that can be stored in the history simultaneous.
get_maxsize
void flush()
Empties the history. All entries in the history are removed, to allow garbage collect to remove them. The entry sequence counter is not reset.
array(int) _indices()
Returns the index numbers of the history entries available.
array _values()
Returns the values of the available history entries.
CLASS ADT.Struct |
Implements a struct which can be used for serialization and deserialization of data.
class ID3 { inherit ADT.Struct; Item head = Chars(3); Item title = Chars(30); Item artist = Chars(30); Item album = Chars(30); Item year = Chars(4); Item comment = Chars(30); Item genre = Byte(); }
Stdio.File f = Stdio.File("foo.mp3"); f->seek(-128); ADT.Struct tag = ID3(f); if(tag->head=="TAG") { write("Title: %s\n", tag->title); tag->title = "A new title" + "\0"*19; f->seek(-128); f->write( (string)tag ); }
class HollerithString { inherit ADT.Struct; Item strlen = Word(); Item str = Chars(strlen); }
void ADT.Struct(void|string|Stdio.File data)
Data to be decoded and populate the struct. Can either be a file object or a string.
void decode(string|Stdio.File data)
Decodes data according to the struct and populates the struct variables. The data can either be a file object or a string.
string encode()
Serializes the struct into a string. This string is equal to the string fed to decode if nothing in the struct has been altered.
mixed `[](string item)
mixed `->(string item)
The struct can be indexed by item name to get the associated value.
mixed `[]=(string item)
mixed `->=(string item)
It is possible to assign a new value to a struct item by indexing it by name and assign a value.
array(string) _indices()
The indices of a struct is the name of the struct items.
array _values()
The values of a struct is the values of the struct items.
int _sizeof()
The size of the struct object is the number of bytes allocated for the struct.
mixed cast(string to)
The struct can be casted into a string, which is eqivivalent to running encode , or into an array. When casted into an array each array element is the encoded value of that struct item.
CLASS ADT.Struct.Item |
Interface class for struct items.
CLASS ADT.Struct.Byte |
One byte, integer value between 0 and 255.
inherit Item : Item
void ADT.Struct.Byte(void|int(0..255) initial_value)
The byte can be initialized with an optional value.
CLASS ADT.Struct.SByte |
One byte, signed integer value between -128 and 127.
inherit Item : Item
void ADT.Struct.SByte(void|int(-128..127) initial_value)
The byte can be initialized with an optional value.
CLASS ADT.Struct.Word |
One word (2 bytes) in network order, integer value between 0 and 65535.
Drow
inherit Item : Item
void ADT.Struct.Word(void|int(0..65535) initial_value)
The word can be initialized with an optional value.
CLASS ADT.Struct.SWord |
One word (2 bytes) in network order, signed integer value between 0 and 65535.
inherit Item : Item
void ADT.Struct.SWord(void|int(-32768..32767) initial_value)
The word can be initialized with an optional value.
CLASS ADT.Struct.Drow |
One word (2 bytes) in intel order, integer value between 0 and 65535.
Word
inherit Word : Word
CLASS ADT.Struct.Long |
One longword (4 bytes) in network order, integer value between 0 and 2^32.
Gnol
inherit Word : Word
void ADT.Struct.Long(void|int(0..) initial_value)
The longword can be initialized with an optional value.
CLASS ADT.Struct.SLong |
One longword (4 bytes) in network order, signed integer value -(2^31) <= x < 2^31-1.
inherit SWord : SWord
void ADT.Struct.SLong(void|int initial_value)
The longword can be initialized with an optional value.
CLASS ADT.Struct.Gnol |
One longword (4 bytes) in intel order, integer value between 0 and 2^32.
Long
inherit Drow : Drow
void ADT.Struct.Gnol(void|int(0..) initial_value)
The longword can be initialized with an optional value.
CLASS ADT.Struct.Chars |
A string of bytes.
inherit Item : Item
void ADT.Struct.Chars(int|Item size, void|string value)
size is the number of bytes that are part of this struct item, or optionally an earlier Item that will be looked up in runtime. The initial value of the char string is value or, if not provided, a string of zero bytes.
CLASS ADT.Struct.int8 |
Alias for SByte
inherit SByte : SByte
CLASS ADT.Struct.uint8 |
Alias for Byte
inherit Byte : Byte
CLASS ADT.Struct.int16 |
Alias for SWord
inherit SWord : SWord
CLASS ADT.Struct.uint16 |
Alias for Word
inherit Word : Word
CLASS ADT.Struct.int32 |
Alias for SLong
inherit SLong : SLong
CLASS ADT.Struct.uint32 |
Alias for Long
inherit Long : Long
CLASS ADT.Struct.int64 |
64 bit signed integer.
inherit SLong : SLong
CLASS ADT.Struct.uint64 |
64 bit unsigned integer.
inherit Long : Long
CLASS ADT.Queue |
A simple FIFO queue.
void ADT.Queue(mixed ... args)
Creates a queue with the initial items args in it.
void write(mixed item)
void put(mixed item)
Adds the item to the queue.
mixed read()
mixed get()
Returns the next element from the queue.
mixed peek()
Returns the next element from the queue without removing it from the queue.
int(0..1) is_empty()
Returns true if the queue is empty, otherwise zero.
void flush()
Empties the queue.
mixed cast(string to)
It is possible to cast ADT.Queue to an array.
CLASS ADT.struct |
String buffer with the possibility to read and write data as they would be formatted in structs.
void ADT.struct(void|string s)
Create a new buffer, optionally initialized with the value s .
string contents()
Trims the buffer to only contain the data after the read pointer and returns the contents of the buffer.
void add_data(string s)
Adds the data s verbatim to the end of the buffer.
string pop_data()
Return all the data in the buffer and empties it.
void put_uint(int i, int(0..) len)
Appends an unsigned integer in network order to the buffer.
Unsigned integer to append.
Length of integer in bytes.
void put_var_string(string s, int(0..) len_width)
Appends a variable string s preceded with an unsigned integer of the size len_width declaring the length of the string. The string s should be 8 bits wide.
void put_bignum(Gmp.mpz i, int(0..)|void len_width)
Appends a bignum i as a variable string preceded with an unsigned integer of the size len_width declaring the length of the string. len_width defaults to 2.
void put_fix_string(string s)
Appends the fix sized string s to the buffer.
void put_fix_uint_array(array(int) data, int(0..) item_size)
Appends an array of unsigned integers of width item_size to the buffer.
void put_var_uint_array(array(int) data, int(0..) item_size, int(0..) len)
Appends an array of unsigned integers of width item_size to the buffer, preceded with an unsigned integer len declaring the size of the array.
int(0..) get_uint(int len)
Reads an unsigned integer from the buffer.
string get_fix_string(int len)
Reads a fixed sized string of length len from the buffer.
string get_var_string(int len)
Reads a string written by put_var_string from the buffer.
Gmp.mpz get_bignum(int|void len)
Reads a bignum written by put_bignum from the buffer.
string get_rest()
Get the remaining data from the buffer and clears the buffer.
array(int) get_fix_uint_array(int item_size, int size)
Reads an array of integers as written by put_fix_uint_array from the buffer.
array(int) get_var_uint_array(int item_size, int len)
Reads an array of integers as written by put_var_uint_array from the buffer.
int(0..1) is_empty()
Returns one of there is any more data to read.
CLASS ADT.BitBuffer |
Implements a FIFO bit buffer, i.e. a buffer that operates on bits instead of bytes. It is not designed for performance, but as a way to handle complicated file formats and other standards where you may need to work on unaligned data units of sub byte size, without having to fry your brain while keeping track of all the bits yourself.
> ADT.BitBuffer b=ADT.BitBuffer(); > b->put1(2); (1) Result: ADT.BitBuffer(11) > b->put0(15); (2) Result: ADT.BitBuffer("À\0"0) > b->drain(); (3) Result: "À\0" > sizeof(b); (4) Result: 1
void ADT.BitBuffer(void|string _data)
The buffer can be initialized with initial data during creation.
this_program feed(string x)
Adds full bytes to the buffer.
string drain()
Drains the buffer of all full (8-bits wide) bytes.
int get(int bits)
Get bits from the buffer.
Throws an error in case of data underflow.
string read(void|int bytes)
Reads bytes (or less) bytes from the buffer and returns as string.
this_program put(int value, int bits)
Put bits number of bits with the value value into the buffer.
value must not be larger than what can be stored with the number of bits given in bits .
this_program put0(int bits)
Put bits number of 0 bits into the buffer.
this_program put1(int bits)
Put bits number of 1 bits into the buffer.
int _sizeof()
sizeof() will return the number of bits in the buffer.
Module ADT.Relation |
CLASS ADT.Relation.Binary |
mixed contains(mixed left, mixed right)
Return true/false: does the relation "left R right " exist?
mixed `()(mixed left, mixed right)
Does the same as the contains function: returns true if the relation "left R right " exists, and otherwise false.
this_program add(mixed left, mixed right)
Adds "left R right " as a member of the relation. Returns the same relation.
this_program remove(mixed left, mixed right)
Removes "left R right " as a member of the relation. Returns the same relation.
array map(function f)
Maps every entry in the relation. The function f gets two arguments: the left and the right relation value. Returns an array with the return values of f for each and every mapped entry.
Note: since the entries in the relation are not ordered, the returned array will have its elements in no particular order. If you need to know which relation entry produced which result in the array, you have to make that information part of the value that f returns.
object filter(function f)
Filters the entries in the relation, and returns a relation with all those entries for which the filtering function f returned true. The function f gets two arguments: the left and the right value for every entry in the relation.
this_program filter_destructively(function f)
Filters the entries in the relation destructively, removing all entries for which the filtering function f returns false. The function f gets two arguments: the left and the right value for each entry in the relation.
mixed _sizeof()
Returns the number of relation entries in the relation. (Or with other words: the number of relations in the relation set.)
mixed `<=(object rel)
The expression `rel1 <= rel2' returns true if every relation entry in rel1 is also present in rel2.
mixed `&(mixed rel)
The expression `rel1 & rel2' returns a new relation which has those and only those relation entries that are present in both rel1 and rel2.
mixed `+(mixed rel)
mixed `|(mixed rel)
The expression `rel1 | rel2' and `rel1 + rel2' returns a new relation which has all the relation entries present in rel1, or rel2, or both.
mixed `-(mixed rel)
The expression `rel1 - rel2' returns a new relation which has those and only those relation entries that are present in rel1 and not present in rel2.
this_program make_symmetric()
Makes the relation symmetric, i.e. makes sure that if xRy is part of the relation set, then yRx should also be a part of the relation set.
array find_shortest_path(mixed from, mixed to, void|multiset avoiding)
Assuming the relation's domain and range sets are equal, and that the relation xRy means "there is a path from node x to node y", find_shortest_path attempts to find a path with a minimum number of steps from one given node to another. The path is returned as an array of nodes (including the starting and ending node), or 0 if no path was found. If several equally short paths exist, one of them will be chosen pseudorandomly.
Trying to find a path from a node to itself will always succeed, returning an array of one element: the node itself. (Or in other words, a path with no steps, only a starting/ending point).
The argument avoiding is either 0 (or omitted), or a multiset of nodes that must not be part of the path.
mixed get_id()
Return the ID value which was given as first argument to create().
CLASS ADT.Relation.Binary._get_iterator |
An iterator which makes all the left/right entities in the relation available as index/value pairs.
Module ADT.Table |
ADT.Table is a generic module for manipulating tables.
Each table contains one or several columns. Each column is associated with a name, the column name. Optionally, one can provide a column type. The Table module can do a number of operations on a given table, like computing the sum of a column, grouping, sorting etc.
All column references are case insensitive. A column can be referred to by its position (starting from zero). All operations are non-destructive. That means that a new table object will be returned after, for example, a sort.
CLASS ADT.Table.table |
The table base-class.
string encode()
This method returns a binary string representation of the table. It is useful when one wants to store a the table, for example in a file.
object decode(string s)
This method returns a table object from a binary string representation of a table, as returned by encode() .
array(string) _indices()
This method returns the column names for the table. The case used when the table was created will be returned.
array(array) _values()
This method returns the contents of a table as a two dimensional array. The format is an array of rows. Each row is an array of columns.
int _sizeof()
This method returns the number of rows in the table.
object reverse()
This method reverses the rows of the table and returns a new table object.
array col(int|string column)
This method returns the contents of a given column as an array.
array row(int row_number)
This method returns the contents of a given row as an array.
array `[](int|string column)
Same as col() .
int `==(object table)
This method compares two tables. They are equal if the contents of the tables and the column names are equal. The column name comparison is case insensitive.
object append_bottom(object table)
This method appends two tables. The table given as an argument will be added at the bottom of the current table. Note, the column names must be equal. The column name comparison is case insensitive.
object append_right(object table)
This method appends two tables. The table given as an argument will be added on the right side of the current table. Note that the number of rows in both tables must be equal.
object select(int|string ... columns)
This method returns a new table object with the selected columns only.
object remove(int|string ... columns)
Like select() , but the given columns will not be in the resulting table.
object where(array(int|string)|int|string columns, function f, mixed ... args)
This method calls the function for each row. If the function returns zero, the row will be thrown away. If the function returns something non-zero, the row will be kept. The result will be returned as a new table object.
this_program group(mapping(int|string:function)|function f, mixed ... args)
This method calls the function f for each column each time a non uniqe row will be joined. The table will be grouped by the columns not listed. The result will be returned as a new table object.
this_program sum(int|string ... columns)
This method sums all equal rows. The table will be grouped by the columns not listed. The result will be returned as a new table object.
this_program distinct(int|string ... columns)
This method groups by the given columns and returns a table with only unique rows. When no columns are given, all rows will be unique. A new table object will be returned.
object map(function f, array(int|string)|int|string columns, mixed ... args)
This method calls the function f for all rows in the table. The value returned will replace the values in the columns given as argument to map. If the function returns an array, several columns will be replaced. Otherwise the first column will be replaced. The result will be returned as a new table object.
object sort(int|string ... columns)
This method sorts the table in ascendent order on one or several columns and returns a new table object. The left most column is sorted last. Note that the sort is stable.
rsort()
object rsort(int|string ... columns)
Like sort() , but in descending order.
object limit(int n)
This method truncates the table to the first n rows and returns a new object.
object rename(string|int from, string to)
This method renames the column named from to to and returns a new table object. Note that from can be the column position.
mapping type(int|string column, void|mapping type)
This method gives the type for the given column .
If a second argument is given, the old type will be replaced with type . The column type is only used when the table is displayed. The format is as specified in create() .
void ADT.Table.table(array(array) table, array(string) column_names, array(mapping(string:string))|void column_types)
The ADT.Table.table class takes two or three arguments:
The first argument is a two-dimensional array consisting of one array of columns per row. All rows must have the same number of columns as specified in column_names .
This argument is an array of column names associated with each column in the table. References by column name are case insensitive. The case used in column_names will be used when the table is displayed. A column can also be referred to by its position, starting from zero.
This is an optional array of mappings. The column type
information is only used when displaying the table. Currently, only the
keyword "type"
is recognized. The type can be specified as
"text"
or "num"
(numerical). Text columns are left
adjusted, whereas numerical columns are right adjusted. If a mapping
in the array is 0 (zero), it will be assumed to be a text column.
If column_types is omitted, all columns will displayed as text.
See ADT.Table.ASCII.encode() on how to display a table.
ADT.Table.ASCII.encode()
Module ADT.Table.ASCII |
string encode(object table, void|mapping options)
This method returns a table represented in ASCII suitable for
human eyes. options is an optional mapping. If the keyword
"indent"
is used with a number, the table will be
indented with that number of space characters.