/ 
Muldis-D-0.41.0
/ Muldis::D::Ext::Array

NAME

Muldis::D::Ext::Array - Muldis D extension for Array specific operators

VERSION

This document is Muldis::D::Ext::Array version 0.28.0.

PREFACE

This document is part of the Muldis D language specification, whose root document is Muldis::D; you should read that root document before you read this one, which provides subservient details.

DESCRIPTION

Muldis D has a mandatory core set of system-defined (eternally available) entities, which is referred to as the Muldis D core or the core; they are the minimal entities that all Muldis D implementations need to provide; they are mutually self-describing and are used to bootstrap the language; any entities outside the core, called Muldis D extensions, are non-mandatory and are defined in terms of the core or each other, but the reverse isn't true.

This current Array document describes the system-defined Muldis D Array Extension, which consists of generic operators that are specific to the Array parameterized relation type, and said operators are short-hands for generic relational operators in the language core.

This current document does not describe the polymorphic operators that all types, or some types including core types, have defined over them; said operators are defined once for all types in Muldis::D::Core.

This documentation is pending.

SYSTEM-DEFINED ARRAY-CONCERNING FUNCTIONS

Each \w*assuming parameter is optional and defaults to the zero-attribute tuple if no explicit argument is given to it.

function sys.std.Array.value result ScaTupRel params { topic(Array), index(UInt) }

This function results in the scalar or nonscalar value attribute of the tuple of topic whose index attribute is index. This function will fail if no tuple exists in topic with the specified index.

function sys.std.Array.update_value result Array params { topic(Array), index(UInt), value(ScaTupRel) }

This function results in its topic argument but that the value attribute of the tuple of topic whose index attribute is index has been updated with a new scalar or nonscalar value given by value. This function will fail if no tuple exists in topic with the specified index, or if the most specific types of the value argument and the value attribute of topic would be fatally incompatible in a common relation value's attribute; this function will otherwise warn if the declared type of value isn't a subtype of the declared type of the value attribute.

function sys.std.Array.insertion result Array params { topic(Array), index(UInt), value(ScaTupRel) }

This function results in its topic argument but that a new tuple has been inserted whose index is index and whose value is value; any existing tuples with index values greater than or equal to index had theirs incremented by 1. As a trivial case, if index is equal to zero or is equal to the cardinality of topic, then value has become the new first or last (or only) element, respectively. This function will fail if index is greater than the cardinality of topic, or it will fail|warn if topic.value and value are incompatible as per update_value.

function sys.std.Array.deletion result Array params { topic(Array), index(UInt) }

This function results in its topic argument but that a tuple has been deleted whose index is index; any existing tuples with index values greater than or equal to index had theirs decremented by 1. This function will fail if no tuple exists in topic with the specified index.

function sys.std.Array.is_element result Bool params { topic(Array), value(ScaTupRel) }

This function results in Bool:true iff its value argument matches the value attribute of at least one tuple of its topic argument (that is, iff conceptually value is an element of topic), and Bool:false otherwise. This function will fail|warn if topic.value and value are incompatible as per update_value.

function sys.std.Array.is_not_element result Bool params { topic(Array), value(ScaTupRel) }

This function is exactly the same as sys.std.Array.is_element except that it results in the opposite boolean value when given the same arguments.

function sys.std.Array.reduction result ScaTupRel params { topic(Array), func(Cat.FuncRef), assuming(QuasiTuple)?, identity(ScaTupRel) }

This function is the same as sys.std.Set.reduction, including that input values for the reduction come from the value attribute of topic, except that it works with an Array rather than a Set. Also, the function named in func is only associative, and not commutative; the arguments to v1 and v2 of func are guaranteed to be consecutive input elements, with the result returning to their place in sequence beween the other input elements.

function sys.std.Array.maybe_reduction result Maybe params { topic(Array), func(Cat.FuncRef), assuming(QuasiTuple)? }

This function is to sys.std.Set.maybe_reduction as sys.std.Array.reduction is to sys.std.Set.reduction.

function sys.std.Array.slice result Array params { topic(Array), first_index(UInt), last_index(UInt) }

This function results in the sub-sequence of its topic argument that is specified by its first_index and last_index arguments, which specify the inclusive source-index range of the elements of the result. This function will fail if last_index is before first_index. It is valid for first_index or last_index to be greater than the last index of topic; in the first case, the result has zero elements; in the second case, the result has all remaining elements starting at first_index. If topic has any elements and first_index matches the index of a source element, then the result will always have at least 1 element.

function sys.std.Array.catenation result Array params { topic(array_of.Array) }

This function results in the catenation of the N element values of its argument; it is a reduction operator that recursively takes each consecutive pair of input values and catenates (which is associative) them together until just one is left, which is the result. To catenate 2 Array means to union their tuples after first increasing all the index values of the second one by the cardinality of the first one. If topic has zero values, then catenate results in the empty sequence value, which is the identity value for catenate.

function sys.std.Array.repeat result Array params { topic(Array), count(UInt) }

This function results in the catenation of count instances of topic.

function sys.std.Array.reverse result Array params { topic(Array) }

This function results in its argument but that the order of its elements has been reversed. For example, the input { 0=>'a', 1=>'b', 2=>'c', 3=>'d'} results in { 0=>'d', 1=>'c', 2=>'b', 3=>'a' }.

function sys.std.Array.is_subarray result Bool params { look_in(Array), look_for(Array) }

This function results in Bool:true iff the sequence of values comprising look_for is a sub-sequence of the sequence of values look_in, and Bool:false otherwise. This function will fail|warn if the 2 arguments don't have a compatible or same heading.

function sys.std.Array.is_not_subarray result Bool params { look_in(Array), look_for(Array) }

This function is exactly the same as sys.std.Array.is_subarray except that it results in the opposite boolean value when given the same arguments.

function sys.std.Array.Array_from_wrap result array_of.Tuple params { topic(Relation), ord_func(Cat.FuncRef), ord_assuming(QuasiTuple)? }

This function results in an Array whose value attribute is tuple-typed and that attribute's values are all the tuples of topic; is a short-hand for a relational wrap of all attributes of topic such that the new tuple-valued attribute is named value, and then that result is extended with an index attribute whose values result from a rank of the tuples, where the ranked-first tuple has an index of zero, and so on. This function is a wrapper over the (total) order_determination function named in its ord_func argument when the latter function is curried by its ord_assuming argument; this wrapped function is used to rank the tuples, with each invocation getting a topic tuple as each its topic and other arguments. See also the sys.std.Relation.rank function, which is the same as sys.std.Array.Array_from_wrap but that it just adds an attribute to the source tuples and does not wrap them.

function sys.std.Array.limit_of_Array_from_wrap result array_of.Tuple params { topic(Relation), ord_func(Cat.FuncRef), ord_assuming(QuasiTuple)?, first_index(UInt), last_index(UInt) }

This function is a short-hand for invoking first sys.std.Array.Array_from_wrap and then sys.std.Array.slice on its result. This function is to sys.std.Array.Array_from_wrap what the sys.std.Relation.limit function is to sys.std.Relation.rank.

function sys.std.Array.Array_from_attr result Array params { topic(Relation), name(Cat.Name), ord_func(Cat.OrdDetFuncRef)?, ord_assuming(QuasiTuple)? }

This function results in an Array consisting of all the values of the attribute of topic named by name. It is a short-hand for a unary projection of just the named attribute plus its renaming to value, and then that result is extended with an index attribute whose values result from a rank of the source attribute values, where the ranked-first source value has an index of zero, and so on. This function is otherwise the same as sys.std.Array.Array_from_wrap. Each of the ord_func and ord_assuming parameters is optional and defaults to sys.std.Core.Scalar.order or the zero-attribute tuple, respectively, if no explicit argument is given to it.

SEE ALSO

Go to Muldis::D for the majority of distribution-internal references, and Muldis::D::SeeAlso for the majority of distribution-external references.

AUTHOR

Darren Duncan (perl@DarrenDuncan.net)

LICENSE AND COPYRIGHT

This file is part of the formal specification of the Muldis D language.

Muldis D is Copyright © 2002-2008, Darren Duncan.

See the LICENSE AND COPYRIGHT of Muldis::D for details.

TRADEMARK POLICY

The TRADEMARK POLICY in Muldis::D applies to this file too.

ACKNOWLEDGEMENTS

The ACKNOWLEDGEMENTS in Muldis::D apply to this file too.