Lisaac prototype interface

Lisaac^TM Platform

NATIVE_ARRAY_VOLATILE

Native array of collection library.

This class gives access to the lowest level for arrays. As any low level array, you can get high performances with NATIVE_ARRAYs, but you loose most valid bounds checks (as you can do in plain C code for example).

Inherit/Insert Summary
`parent_safe_equal` No developed.

Constructor Summary
`create` Allocate a new array of nb_elements of type E. The new array is initialized with default values.

Basic features:
`object_size` For detect error.
`element_sizeof` The size in number of bytes for type E.
`calloc_intern` Allocate a new array of 'nb_elements' of type E. The new array is initialized with default values.
`realloc with` Assume Current is a valid NATIVE_ARRAY_VOLATILE in range [0 .. old_nb_elts-1]. Allocate a bigger new array in range [0 .. new_nb_elts-1]. Old range is copied in the new allocated array. New items are initialized with default values.
`first`
`item` To read an `item`. Assume that calloc is already done and that index is the range [0 .. nb_elements-1].
`put to` To write an item. Assume that calloc is already done and that index is the range [0 .. nb_elements-1].

Displacement
`Infix '+'` other is in element index

Comparison:
`memcmp until` True if all elements in range [0..capacity-1] are identical using equal. Assume Current and other are big enough. See also fast_memcmp.
`slice_memcmp` True if all elements in range [0 .. other_upper - other_lower] are identical to the elements in range [other_lower .. other_upper] of other using is_equal. Assume Current and other are big enough. See also `slice_fast_memcmp`.
`fast_memcmp until` Same jobs as memcmp but uses infix = instead equal.
`slice_fast_memcmp` Same jobs as `slice_memcmp` but uses infix "=" instead of is_equal.
`deep_memcmp until` Same jobs as memcmp but uses is_deep_equal instead equal.
`slice_deep_memcmp` Same jobs as `slice_memcmp` but uses is_deep_equal instead of is_equal.

Searching:
`first_index_of until` Give the index of the first occurrence of element using == for comparison. Answer upper + 1 when element is not inside. See also fast_index_of, reverse_index_of.
`index_of until` Using is_equal for comparison, gives the index of the first occurrence of element at or after start_index. Answer upper + 1 when the search fail. See also fast_index_of, reverse_index_of.
`reverse_index_of from` Give the index of the first occurrence of element using == for comparison, from upper to lower. Answer -1 when element is not inside.
`fast_index_of until` Using basic = for comparison, gives the index of the first occurrence of element at or after start_index. Answer upper + 1 when the search fail. See also index_of, reverse_index_of.
`fast_reverse_index_of from` Same as reverse_index_of but use basic = for comparison. Search is done in reverse direction, which means from upper down to the 0. Answer -1 when the search fail. See also reverse_index_of, index_of.
`fast_first_index_of until` Same as index_of but use basic = for comparison. 0. Answer upper + 1 when the search fail. See also fast_index_of, reverse_index_of.
`has until` Look for element using == for comparison. Also consider has to choose the most appropriate.
`fast_has until` Look for element using basic = for comparison. Also consider has to choose the most appropriate.

Removing:
`remove_first` Assume upper is a valid index. Move range [1 .. upper] by 1 position left.
`remove until` Assume upper is a valid index. Move range [index + 1 .. upper] by 1 position left.

Replacing:
`replace_all with until` Replace all occurences of the element old_value by new_value using == for comparison. See also fast_replace_all to choose the apropriate one.
`fast_replace_all with until` Replace all occurences of the element old_value by new_value using basic = for comparison. See also replace_all to choose the apropriate one.

Adding:
`copy to until` Copy range [0 .. src_capacity - 1] of src to range [dest .. dest + src_capacity - 1] of Self. No subscript checking.
`slice_copy to from to` Copy range [src_min .. src_max] of src to range [at .. at + src_max - src_min - 1] of Current. No subscript checking.

Other:
`set_all_with until` Set all elements in range [0 .. upper] with value v.
`set_slice_with from until` Set all elements in range [lower .. upper] with value v.
`clear_all` Set all elements in range [0 .. upper] with the default value.
`clear to` Set all elements in range [lower .. upper] with the default value
`copy_from until` Assume upper is a valid index both in Current and model.
`deep_twin_from` To implement deep_twin. Allocate a new array of capacity initialized with deep_twin. Assume capacity is valid both in Current and model.
`move to by` Move range [lower .. upper] by offset positions. Freed positions are not initialized to default values.
`occurrences until` Number of occurrences of element in range [0..upper] using equal for comparison. See also fast_occurrences to chose the apropriate one.
`slice_occurrences from until` Number of occurrences of element in range [lower .. upper] using is_equal for comparison. See also slice_fast_occurrences to chose the apropriate one.
`fast_occurrences until` Number of occurrences of element in range [0..upper] using basic "=" for comparison. See also fast_occurrences to chose the apropriate one.
`slice_fast_occurrences from until` Number of occurrences of element in range [lower .. upper] using basic "=" for comparison. See also slice_occurrences to chose the apropriate one.
`all_default` Do all items in range [0 .. upper] have their type's default value?
`slice_default to` Do all items in range [lower .. upper] have their type's default value? Note: for non Void items, the test is performed with the is_default predicate.

Interfacing with C:
`to_external` Gives access to the C pointer on the area of storage.
`is_null`
`is_not_null`

Guru Section
`force_put to` Used in Memory count: not to use directly without caution !

Inherit/Insert Detail

parent_safe_equal

.../base/collection/low_level/native_array_volatile.li line #16
Section:: Inherit
Profile:: - Self: SELF. parent_safe_equal : SAFE_EQUAL( V)

Constructor Detail

create

.../base/collection/low_level/native_array_volatile.li line #57
Section:: Public
Profile:: - Self: SELF. create nb_elements : INTEGER : NATIVE_ARRAY_VOLATILE( V)
Description:: Allocate a new array of nb_elements of type E. The new array is initialized with default values.

Basic features:

object_size

.../base/collection/low_level/native_array_volatile.li line #24
Section:: Public
Profile:: - Self: SELF. object_size : INTEGER
Description:: For detect error.

element_sizeof

.../base/collection/low_level/native_array_volatile.li line #26
Section:: Public
Profile:: - Self: SELF. element_sizeof : INTEGER
Description:: The size in number of bytes for type E.

calloc_intern

.../base/collection/low_level/native_array_volatile.li line #37
Section:: Public
Profile:: - Self: SELF. calloc_intern nb_elements : INTEGER : NATIVE_ARRAY_VOLATILE( V)
Description:: Allocate a new array of 'nb_elements' of type E. The new array is initialized with default values.

realloc with

.../base/collection/low_level/native_array_volatile.li line #73
Section:: Public
Profile:: - Self: SELF. realloc old_nb_elts : INTEGER with new_nb_elts : INTEGER : NATIVE_ARRAY_VOLATILE( V)
Description:: Assume Current is a valid NATIVE_ARRAY_VOLATILE in range [0 .. old_nb_elts-1]. Allocate a bigger new array in range [0 .. new_nb_elts-1]. Old range is copied in the new allocated array. New items are initialized with default values.

first

.../base/collection/low_level/native_array_volatile.li line #102
Section:: Public
Profile:: - Self: SELF. first : V

item

.../base/collection/low_level/native_array_volatile.li line #104
Section:: Public
Profile:: - Self: SELF. item index : INTEGER : V
Description:: To read an item. Assume that calloc is already done and that index is the range [0 .. nb_elements-1].

put to

.../base/collection/low_level/native_array_volatile.li line #115
Section:: Public
Profile:: - Self: SELF. put element : V to index : INTEGER
Description:: To write an item. Assume that calloc is already done and that index is the range [0 .. nb_elements-1].

Displacement

Infix '+'

.../base/collection/low_level/native_array_volatile.li line #133
Section:: Public
Profile:: - Self: SELF ' + ' Left 80 other : INTEGER : NATIVE_ARRAY_VOLATILE( V)
Description:: other is in element index

Comparison:

memcmp until

.../base/collection/low_level/native_array_volatile.li line #146
Section:: Public
Profile:: - Self: SELF. memcmp other : NATIVE_ARRAY_VOLATILE( V) until capacity : INTEGER : BOOLEAN
Description:: True if all elements in range [0..capacity-1] are identical using equal. Assume Current and other are big enough. See also fast_memcmp.

slice_memcmp

.../base/collection/low_level/native_array_volatile.li line #163
Section:: Public
Profile:: - Self: SELF. slice_memcmp ( at : INTEGER, other : NATIVE_ARRAY_VOLATILE( V), other_lower : INTEGER, other_upper : INTEGER) : BOOLEAN
Description:: True if all elements in range [0 .. other_upper - other_lower] are identical to the elements in range [other_lower .. other_upper] of other using is_equal. Assume Current and other are big enough. See also slice_fast_memcmp.

fast_memcmp until

.../base/collection/low_level/native_array_volatile.li line #183
Section:: Public
Profile:: - Self: SELF. fast_memcmp other : NATIVE_ARRAY_VOLATILE( V) until capacity : INTEGER : BOOLEAN
Description:: Same jobs as memcmp but uses infix = instead equal.

slice_fast_memcmp

.../base/collection/low_level/native_array_volatile.li line #197
Section:: Public
Profile:: - Self: SELF. slice_fast_memcmp ( at : INTEGER, other : NATIVE_ARRAY_VOLATILE( V), other_lower : INTEGER, other_upper : INTEGER) : BOOLEAN
Description:: Same jobs as slice_memcmp but uses infix "=" instead of is_equal.

deep_memcmp until

.../base/collection/low_level/native_array_volatile.li line #214
Section:: Public
Profile:: - Self: SELF. deep_memcmp other : NATIVE_ARRAY_VOLATILE( V) until capacity : INTEGER : BOOLEAN
Description:: Same jobs as memcmp but uses is_deep_equal instead equal.

slice_deep_memcmp

.../base/collection/low_level/native_array_volatile.li line #242
Section:: Public
Profile:: - Self: SELF. slice_deep_memcmp ( at : INTEGER, other : NATIVE_ARRAY_VOLATILE( V), other_lower : INTEGER, other_upper : INTEGER) : BOOLEAN
Description:: Same jobs as slice_memcmp but uses is_deep_equal instead of is_equal.

Searching:

first_index_of until

.../base/collection/low_level/native_array_volatile.li line #278
Section:: Public
Profile:: - Self: SELF. first_index_of element : V until upper : INTEGER : INTEGER
Description:: Give the index of the first occurrence of element using == for comparison. Answer upper + 1 when element is not inside. See also fast_index_of, reverse_index_of.

index_of until

.../base/collection/low_level/native_array_volatile.li line #294
Section:: Public
Profile:: - Self: SELF. index_of ( element : V, start_index : INTEGER) until upper : INTEGER : INTEGER
Description:: Using is_equal for comparison, gives the index of the first occurrence of element at or after start_index. Answer upper + 1 when the search fail. See also fast_index_of, reverse_index_of.

reverse_index_of from

.../base/collection/low_level/native_array_volatile.li line #315
Section:: Public
Profile:: - Self: SELF. reverse_index_of element : V from upper : INTEGER : INTEGER
Description:: Give the index of the first occurrence of element using == for comparison, from upper to lower. Answer -1 when element is not inside.

fast_index_of until

.../base/collection/low_level/native_array_volatile.li line #335
Section:: Public
Profile:: - Self: SELF. fast_index_of ( element : V, start_index : INTEGER) until upper : INTEGER : INTEGER
Description:: Using basic = for comparison, gives the index of the first occurrence of element at or after start_index. Answer upper + 1 when the search fail. See also index_of, reverse_index_of.

fast_reverse_index_of from

.../base/collection/low_level/native_array_volatile.li line #356
Section:: Public
Profile:: - Self: SELF. fast_reverse_index_of element : V from upper : INTEGER : INTEGER
Description:: Same as reverse_index_of but use basic = for comparison. Search is done in reverse direction, which means from upper down to the 0. Answer -1 when the search fail. See also reverse_index_of, index_of.

fast_first_index_of until

.../base/collection/low_level/native_array_volatile.li line #377
Section:: Public
Profile:: - Self: SELF. fast_first_index_of element : V until upper : INTEGER : INTEGER
Description:: Same as index_of but use basic = for comparison. 0. Answer upper + 1 when the search fail. See also fast_index_of, reverse_index_of.

has until

.../base/collection/low_level/native_array_volatile.li line #396
Section:: Public
Profile:: - Self: SELF. has element : V until upper : INTEGER : BOOLEAN
Description:: Look for element using == for comparison. Also consider has to choose the most appropriate.

fast_has until

.../base/collection/low_level/native_array_volatile.li line #413
Section:: Public
Profile:: - Self: SELF. fast_has element : V until upper : INTEGER : BOOLEAN
Description:: Look for element using basic = for comparison. Also consider has to choose the most appropriate.

Removing:

remove_first

.../base/collection/low_level/native_array_volatile.li line #432
Section:: Public
Profile:: - Self: SELF. remove_first upper : INTEGER
Description:: Assume upper is a valid index. Move range [1 .. upper] by 1 position left.

remove until

.../base/collection/low_level/native_array_volatile.li line #446
Section:: Public
Profile:: - Self: SELF. remove index : INTEGER until upper : INTEGER
Description:: Assume upper is a valid index. Move range [index + 1 .. upper] by 1 position left.

Replacing:

replace_all with until

.../base/collection/low_level/native_array_volatile.li line #466
Section:: Public
Profile:: - Self: SELF. replace_all old_value : V with new_value : V until upper : INTEGER
Description:: Replace all occurences of the element old_value by new_value using == for comparison. See also fast_replace_all to choose the apropriate one.

fast_replace_all with until

.../base/collection/low_level/native_array_volatile.li line #481
Section:: Public
Profile:: - Self: SELF. fast_replace_all old_value : V with new_value : V until upper : INTEGER
Description:: Replace all occurences of the element old_value by new_value using basic = for comparison. See also replace_all to choose the apropriate one.

Adding:

copy to until

.../base/collection/low_level/native_array_volatile.li line #500
Section:: Public
Profile:: - Self: SELF. copy src : NATIVE_ARRAY_VOLATILE( V) to dest : INTEGER until src_capacity : INTEGER
Description:: Copy range [0 .. src_capacity - 1] of src to range [dest .. dest + src_capacity - 1] of Self. No subscript checking.

slice_copy to from to

.../base/collection/low_level/native_array_volatile.li line #518
Section:: Public
Profile:: - Self: SELF. slice_copy src : NATIVE_ARRAY_VOLATILE( V) to dest : INTEGER from src_min : INTEGER to src_max : INTEGER
Description:: Copy range [src_min .. src_max] of src to range [at .. at + src_max - src_min - 1] of Current. No subscript checking.

Other:

set_all_with until

.../base/collection/low_level/native_array_volatile.li line #542
Section:: Public
Profile:: - Self: SELF. set_all_with v : V until upper : INTEGER
Description:: Set all elements in range [0 .. upper] with value v.

set_slice_with from until

.../base/collection/low_level/native_array_volatile.li line #554
Section:: Public
Profile:: - Self: SELF. set_slice_with v : V from lower : INTEGER until upper : INTEGER
Description:: Set all elements in range [lower .. upper] with value v.

clear_all

.../base/collection/low_level/native_array_volatile.li line #569
Section:: Public
Profile:: - Self: SELF. clear_all upper : INTEGER
Description:: Set all elements in range [0 .. upper] with the default value.

clear to

.../base/collection/low_level/native_array_volatile.li line #582
Section:: Public
Profile:: - Self: SELF. clear lower : INTEGER to upper : INTEGER
Description:: Set all elements in range [lower .. upper] with the default value

copy_from until

.../base/collection/low_level/native_array_volatile.li line #596
Section:: Public
Profile:: - Self: SELF. copy_from model : NATIVE_ARRAY_VOLATILE( V) until upper : INTEGER
Description:: Assume upper is a valid index both in Current and model.

deep_twin_from

.../base/collection/low_level/native_array_volatile.li line #607
Section:: Public
Profile:: - Self: SELF. deep_twin_from capacity : INTEGER : NATIVE_ARRAY_VOLATILE( V)
Description:: To implement deep_twin. Allocate a new array of capacity initialized with deep_twin. Assume capacity is valid both in Current and model.

move to by

.../base/collection/low_level/native_array_volatile.li line #629
Section:: Public
Profile:: - Self: SELF. move lower : INTEGER to upper : INTEGER by offset : INTEGER
Description:: Move range [lower .. upper] by offset positions. Freed positions are not initialized to default values.

occurrences until

.../base/collection/low_level/native_array_volatile.li line #651
Section:: Public
Profile:: - Self: SELF. occurrences element : V until upper : INTEGER : INTEGER
Description:: Number of occurrences of element in range [0..upper] using equal for comparison. See also fast_occurrences to chose the apropriate one.

slice_occurrences from until

.../base/collection/low_level/native_array_volatile.li line #668
Section:: Public
Profile:: - Self: SELF. slice_occurrences element : V from lower : INTEGER until upper : INTEGER : INTEGER
Description:: Number of occurrences of element in range [lower .. upper] using is_equal for comparison. See also slice_fast_occurrences to chose the apropriate one.

fast_occurrences until

.../base/collection/low_level/native_array_volatile.li line #688
Section:: Public
Profile:: - Self: SELF. fast_occurrences element : V until upper : INTEGER : INTEGER
Description:: Number of occurrences of element in range [0..upper] using basic "=" for comparison. See also fast_occurrences to chose the apropriate one.

slice_fast_occurrences from until

.../base/collection/low_level/native_array_volatile.li line #705
Section:: Public
Profile:: - Self: SELF. slice_fast_occurrences element : V from lower : INTEGER until upper : INTEGER : INTEGER
Description:: Number of occurrences of element in range [lower .. upper] using basic "=" for comparison. See also slice_occurrences to chose the apropriate one.

all_default

.../base/collection/low_level/native_array_volatile.li line #725
Section:: Public
Profile:: - Self: SELF. all_default upper : INTEGER : BOOLEAN
Description:: Do all items in range [0 .. upper] have their type's default value?

slice_default to

.../base/collection/low_level/native_array_volatile.li line #743
Section:: Public
Profile:: - Self: SELF. slice_default lower : INTEGER to upper : INTEGER : BOOLEAN
Description:: Do all items in range [lower .. upper] have their type's default value? Note: for non Void items, the test is performed with the is_default predicate.

Interfacing with C:

to_external

.../base/collection/low_level/native_array_volatile.li line #770
Section:: Public
Profile:: - Self: SELF. to_external : POINTER
Description:: Gives access to the C pointer on the area of storage.

is_null

.../base/collection/low_level/native_array_volatile.li line #773
Section:: Public
Profile:: - Self: SELF. is_null : BOOLEAN

is_not_null

.../base/collection/low_level/native_array_volatile.li line #775
Section:: Public
Profile:: - Self: SELF. is_not_null : BOOLEAN

Guru Section

force_put to

.../base/collection/low_level/native_array_volatile.li line #781
Section:: Public
Profile:: - Self: SELF. force_put element : V to index : INTEGER
Description:: Used in Memory count: not to use directly without caution !