A thin wrapper around a NativeCArray adding length information

Introduced properties

type NATIVE: NativeCArray

c :: CArray :: NATIVE

The corresponding C type
fun []=(index: Int, val: E)

c :: CArray :: []=

Set val at index.
init defaultinit(length: Int)

c :: CArray :: defaultinit

fun destroy

c :: CArray :: destroy

Free used memory used by native_array.
fun destroyed: Bool

c :: CArray :: destroyed

Was this instance destroyed?
protected fun destroyed=(destroyed: Bool)

c :: CArray :: destroyed=

Was this instance destroyed?
fun native_array: NATIVE

c :: CArray :: native_array

Pointer to the real C array
protected fun native_array=(native_array: NATIVE)

c :: CArray :: native_array=

Pointer to the real C array

Redefined properties

redef type SELF: CArray[E]

c $ CArray :: SELF

Type of this instance, automatically specialized in every class
redef fun [](index: Int): E

c $ CArray :: []

Return the index-th element of the sequence.

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type CONCURRENT: ConcurrentCollection[E]

core :: Collection :: CONCURRENT

Type of the concurrent variant of this collection
type NATIVE: NativeCArray

c :: CArray :: NATIVE

The corresponding C type
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
abstract fun [](index: Int): E

core :: SequenceRead :: []

Return the index-th element of the sequence.
fun []=(index: Int, val: E)

c :: CArray :: []=

Set val at index.
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun combinations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations

All r-length combinations on self (in same order) without repeated elements.
fun combinations_with_replacement(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations_with_replacement

All r-length combination on self (in same order) with repeated elements.
fun copy_to(start: Int, len: Int, dest: AbstractArray[E], new_start: Int)

core :: AbstractArrayRead :: copy_to

Copy a portion of self to an other array.
fun count(item: nullable Object): Int

core :: Collection :: count

How many occurrences of item are in the collection?
init defaultinit(length: Int)

c :: CArray :: defaultinit

fun destroy

c :: CArray :: destroy

Free used memory used by native_array.
fun destroyed: Bool

c :: CArray :: destroyed

Was this instance destroyed?
protected fun destroyed=(destroyed: Bool)

c :: CArray :: destroyed=

Was this instance destroyed?
fun first: E

core :: Collection :: first

Return the first item of the collection
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun get_or_default(index: Int, default: E): E

core :: SequenceRead :: get_or_default

Try to get an element, return default if the index is invalid.
fun get_or_null(index: Int): nullable E

core :: SequenceRead :: get_or_null

Try to get an element, return null if the index is invalid.
fun has(item: nullable Object): Bool

core :: Collection :: has

Is item in the collection ?
fun has_all(other: Collection[nullable Object]): Bool

core :: Collection :: has_all

Does the collection contain at least each element of other?
fun has_any(other: Collection[nullable Object]): Bool

core :: Collection :: has_any

Does the collection contain at least one element of other?
fun has_exactly(other: Collection[nullable Object]): Bool

core :: Collection :: has_exactly

Does the collection contain exactly all the elements of other?
fun has_only(item: nullable Object): Bool

core :: Collection :: has_only

Is the collection contain only item?
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun index_of(item: nullable Object): Int

core :: SequenceRead :: index_of

The index of the first occurrence of item.
fun index_of_from(item: nullable Object, pos: Int): Int

core :: SequenceRead :: index_of_from

The index of the first occurrence of item, starting from pos.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
fun is_empty: Bool

core :: Collection :: is_empty

Is there no item in the collection?
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
abstract fun iterator: Iterator[E]

core :: Collection :: iterator

Get a new iterator on the collection.
fun iterator_from(pos: Int): IndexedIterator[E]

core :: SequenceRead :: iterator_from

Gets a new Iterator starting at position pos
fun join(separator: nullable Text, last_separator: nullable Text): String

core :: Collection :: join

Concatenate and separate each elements with separator.
fun last: E

core :: SequenceRead :: last

Get the last item.
fun last_index_of(item: nullable Object): Int

core :: SequenceRead :: last_index_of

The index of the last occurrence of item.
fun last_index_of_from(item: nullable Object, pos: Int): Int

core :: SequenceRead :: last_index_of_from

The index of the last occurrence of item starting from pos and decrementing.
fun length: Int

core :: Collection :: length

Number of items in the collection.
protected fun length=(length: Int)

core :: AbstractArrayRead :: length=

fun modulo(index: Int): E

core :: SequenceRead :: modulo

Return the index-th element but wrap
fun modulo_index(index: Int): Int

core :: SequenceRead :: modulo_index

Returns the real index for a modulo index.
fun native_array: NATIVE

c :: CArray :: native_array

Pointer to the real C array
protected fun native_array=(native_array: NATIVE)

c :: CArray :: native_array=

Pointer to the real C array
fun not_empty: Bool

core :: Collection :: not_empty

Alias for not is_empty.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun permutations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: permutations

All r-length permutations on self (all possible ordering) without repeated elements.
fun plain_to_s: String

core :: Collection :: plain_to_s

Concatenate elements without separators
fun product(r: Int): Collection[SequenceRead[E]]

core :: Collection :: product

Cartesian product, over r times self.
fun rand: E

core :: Collection :: rand

Return a random element form the collection
protected abstract fun recv(mpi: MPI, at: Int, count: Int, source: Rank, tag: Tag, comm: Comm)

mpi :: Receptacle :: recv

Type specific receive from MPI
protected abstract fun recv_fill(mpi: MPI, source: Rank, tag: Tag, comm: Comm)

mpi :: Receptacle :: recv_fill

Type specific receive and fill buffer from MPI
abstract fun reverse_iterator: IndexedIterator[E]

core :: SequenceRead :: reverse_iterator

Gets an iterator starting at the end and going backwards
fun reverse_iterator_from(pos: Int): IndexedIterator[E]

core :: SequenceRead :: reverse_iterator_from

Gets an iterator on the chars of self starting from pos
fun reversed: Array[E]

core :: AbstractArrayRead :: reversed

Return a new array that is the reverse of self
fun sample(length: Int): Array[E]

core :: Collection :: sample

Return a new array made of (at most) length elements randomly chosen.
protected abstract fun send(mpi: MPI, at: Int, count: Int, dest: Rank, tag: Tag, comm: Comm)

mpi :: Sendable :: send

Type specific send over MPI
protected abstract fun send_all(mpi: MPI, dest: Rank, tag: Tag, comm: Comm)

mpi :: Sendable :: send_all

Type specific send full buffer over MPI
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun sub(from: Int, count: Int): Array[E]

core :: AbstractArrayRead :: sub

Returns a sub-array containing count elements starting from from.
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_a: Array[E]

core :: Collection :: to_a

Build a new array from a collection
abstract fun to_concurrent: CONCURRENT

core :: Collection :: to_concurrent

Wraps self in a thread-safe collection
fun to_counter: Counter[E]

core :: Collection :: to_counter

Create and fill up a counter with the elements of `self.
fun to_curlslist: CURLSList

core :: Collection :: to_curlslist

Convert Collection[String] to CURLSList
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun to_shuffle: Array[E]

core :: Collection :: to_shuffle

Return a new array made of elements in a random order.
package_diagram c::CArray CArray core::AbstractArrayRead AbstractArrayRead c::CArray->core::AbstractArrayRead mpi::Sendable Sendable c::CArray->mpi::Sendable mpi::Receptacle Receptacle c::CArray->mpi::Receptacle core::SequenceRead SequenceRead core::AbstractArrayRead->core::SequenceRead core::Object Object mpi::Sendable->core::Object mpi::Receptacle->core::Object ...core::SequenceRead ... ...core::SequenceRead->core::SequenceRead ...core::Object ... ...core::Object->core::Object c::CIntArray CIntArray c::CIntArray->c::CArray c::CUInt16Array CUInt16Array c::CUInt16Array->c::CArray c::CByteArray CByteArray c::CByteArray->c::CArray c::CCStringArray CCStringArray c::CCStringArray->c::CArray

Ancestors

interface Collection[E: nullable Object]

core :: Collection

The root of the collection hierarchy.
interface Object

core :: Object

The root of the class hierarchy.
interface SequenceRead[E: nullable Object]

core :: SequenceRead

Sequences are indexed collections.

Parents

abstract class AbstractArrayRead[E: nullable Object]

core :: AbstractArrayRead

One dimension array of objects.
interface Receptacle

mpi :: Receptacle

Something which can receive data directly and efficiently from MPI
interface Sendable

mpi :: Sendable

Something sendable directly and efficiently over MPI

Children

class CByteArray

c :: CByteArray

Wrapper around an array of unsigned char in C (unsigned char*) with length and destroy state
class CCStringArray

c :: CCStringArray

Wrapper around an array of CString in C (char**) with length and destroy state.
class CIntArray

c :: CIntArray

Wrapper around an array of int in C (int*) with length and destroy state
class CUInt16Array

c :: CUInt16Array

Wrapper of a C array of type uint16_t* with length and destroy state

Class definitions

c $ CArray
# A thin wrapper around a `NativeCArray` adding length information
abstract class CArray[E]
	super AbstractArrayRead[E]

	# The corresponding C type
	type NATIVE: NativeCArray

	# Pointer to the real C array
	var native_array: NATIVE is noinit

	init(length: Int) is old_style_init do self._length = length

	redef fun [](index)
	do
		assert not destroyed
		assert index >= 0 and index < length
		return native_array[index]
	end

	# Set `val` at `index`.
	fun []=(index: Int, val: E)
	do
		assert not destroyed
		assert index >= 0 and index < length
		native_array[index] = val
	end

	# Was this instance destroyed?
	#
	# See `CArray::destroy`.
	var destroyed = false

	# Free used memory used by `native_array`.
	#
	# Also set `destroyed` to true.
	fun destroy
	do
		if destroyed then return

		native_array.free
		destroyed = true
	end
end
lib/c/c.nit:23,1--65,3

mpi :: mpi $ CArray
redef class CArray[E]
	super Sendable
	super Receptacle
end
lib/mpi/mpi.nit:414,1--417,3