SalArray<T>

PPJ.Runtime.SalArray<T>

Namespace: PPJ.Runtime

Assembly: PPJ.Web.49 (4.9.0.0)

Dynamic array generic class. This class replicates SAL dynamic arrays. It can be used without being declared as an inner class by using the new generics syntax.

public class SalArray<T> : SalArray, IEnumerable<T>, IList<T>, ICollection<T>

Parameters

Name
Description

T

Constructors

SalArray()

Constructs a new dynamic array.

SalArray(lengths)

Constructs a new array.

Name
Type
Description

lengths

SalArray(bounds)

Constructs a new array. Example: new SalArray("2:3")

Name
Type
Description

bounds

String definition of the array dimensions. It can specify lower bounds as "2:3".

Properties

Item(index)

T: Returns or sets the item at the specified index.

Item(indices)

T: Returns or sets the item at the specified coordinates in a multidimensional array.

Items

T[]: Returns the internal array.

Methods

Add(item)

Adds an object to the end of the array.

Parameter
Type
Description

item

The object to be added to the end of the array. The value can be null for reference types.

AddRange(collection)

Adds the elements of the specified collection to the end of the array.

Parameter
Type
Description

collection

The collection whose elements should be added to the end of the array. The collection itself cannot be null, but it can contain elements that are null, if type collection is a reference type.

Throws:

Contains(item)

Determines whether an element is in the array.

Parameter
Type
Description

item

The object to locate in the array. The value can be null for reference types.

Returns: Boolean. true if item is found in the array; otherwise, false.

CopyTo(array)

Copies the entire array to a compatible one-dimensional array, starting at the beginning of the target array.

Parameter
Type
Description

array

The one-dimensional Array that is the destination of the elements copied. The Array must have zero-based indexing.

Throws:

CopyTo(array, arrayIndex)

Copies the entire array to a compatible one-dimensional array, starting at the specified index of the target array.

Parameter
Type
Description

array

The one-dimensional Array that is the destination of the elements copied. The Array must have zero-based indexing.

arrayIndex

The zero-based index in array at which copying begins.

Throws:

GetArray()

Returns the internal array.

Returns: T[].

GetArray(minLength)

Returns the internal array resized to guarantee the specified minimum unmber of items.

Parameter
Type
Description

minLength

The minimum number of items that should be ensured in the array.

Returns: T[].

GetArray(minLength1, minLength2)

Returns the internal multidimensional array resized to guarantee the specified number of items in each dimension.

Parameter
Type
Description

minLength1

The minimum number of items for the first dimension.

minLength2

The minimum number of items for the second dimension.

Returns: T[,].

GetArray(minLength1, minLength2, minLength3)

Returns the internal multidimensional array resized to guarantee the specified number of items in each dimension.

Parameter
Type
Description

minLength1

The minimum number of items for the first dimension.

minLength2

The minimum number of items for the second dimension.

minLength3

The minimum number of items for the third dimension.

Returns: T[,,].

GetArray(minLength1, minLength2, minLength3, minLength4)

Returns the internal multidimensional array resized to guarantee the specified number of items in each dimension.

Parameter
Type
Description

minLength1

The minimum number of items for the first dimension.

minLength2

The minimum number of items for the second dimension.

minLength3

The minimum number of items for the third dimension.

minLength4

The minimum number of items for the fourth dimension.

Returns: T[,,,].

IndexOf(item)

Searches for the specified object and returns the zero-based index of the first occurrence within the entire array.

Parameter
Type
Description

item

The object to locate in the array. The value can be null for reference types.

Returns: Int32. The zero-based index of the first occurrence of item , if found; otherwise, –1.

IndexOf(item, index)

Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the array.

Parameter
Type
Description

item

The object to locate in the array. The value can be null for reference types.

index

The zero-based starting index of the search. 0 (zero) is valid in an empty list.

Returns: Int32. The zero-based index of the first occurrence of item within the range of elements, if found; otherwise, –1.

Throws:

Insert(index, item)

Inserts an element into the array at the specified index.

Parameter
Type
Description

index

The zero-based index at which item should be inserted.

item

The object to insert. The value can be null for reference types.

Throws:

InsertRange(index, collection)

Inserts the elements of a collection into the array at the specified index.

Parameter
Type
Description

index

The zero-based index at which the new elements should be inserted.

collection

The collection whose elements should be inserted. The collection itself cannot be null, but it can contain elements that are null, if type collection is a reference type.

Throws:

Remove(item)

Removes the first occurrence of a specific object from the array.

Parameter
Type
Description

item

The object to remove from the array. The value can be null for reference types.

Returns: Boolean. true if item is successfully removed; otherwise, false. This method also returns false if item was not found.

RemoveAt(index)

Removes the element at the specified index.

Parameter
Type
Description

index

The zero-based index of the element to remove.

Throws:

Sort(comparison)

Sorts the items in the array using the specified comparison expression.

Parameter
Type
Description

comparison

The comparison expression.

Implements

Name
Description

Common base interface for Sal types.

Last updated