IOLink C# 1.11.0
Loading...
Searching...
No Matches
IOLink.ArrayXu8 Class Reference

A multi dimensionnal array. More...

Inheritance diagram for IOLink.ArrayXu8:

Public Member Functions

 ArrayXu8 (global::System.IntPtr cPtr, bool cMemoryOwn)
 
void Dispose ()
 
override bool Equals (object obj)
 
 ArrayXu8 (VectorXu64 shape)
 Create an array with the given shape.
 
 ArrayXu8 (Indexer indexer)
 Create an array with a memory layout fitting the given indexer.
 
 ArrayXu8 (ArrayXu8 other)
 
uint DimensionCount ()
 The number of dimensions of the array.
 
VectorXu64 Shape ()
 Return the shape of the array.
 
byte At (VectorXu64 index)
 Get an element of the array.
 
void SetAt (VectorXu64 index, byte value)
 Set a value to an element of the array.
 
void Reshape (VectorXu64 shape)
 Change the shape of the array.
 
string ToString ()
 Return a string representation.
 

Static Public Member Functions

static global::System.Runtime.InteropServices.HandleRef getCPtr (ArrayXu8 obj)
 
static global::System.Runtime.InteropServices.HandleRef swigRelease (ArrayXu8 obj)
 
static bool operator== (ArrayXu8 v1, ArrayXu8 v2)
 
static bool operator!= (ArrayXu8 v1, ArrayXu8 v2)
 
static bool InternalEqual (ArrayXu8 lhs, ArrayXu8 rhs)
 

Protected Member Functions

virtual void Dispose (bool disposing)
 

Protected Attributes

bool swigCMemOwn
 

Properties

byte this[params ulong[] indices [get, set]
 

Detailed Description

A multi dimensionnal array.

This class should not be used as is, you must use its aliases or it will not work. The current aliases are:

  • Arrayi8
  • Arrayi16
  • Arrayi32
  • Arrayi64
  • Arrayu8
  • Arrayu16
  • Arrayu32
  • Arrayu64
  • Arrayf
  • Arrayd
    Parameters
    TThe type of element stored in the array.

Constructor & Destructor Documentation

◆ ArrayXu8() [1/2]

IOLink.ArrayXu8.ArrayXu8 ( VectorXu64  shape)
inline

Create an array with the given shape.

The memory layout of the array will be the default one used by IOLink, the Fortran one, in wich the leftmost dimension is the continuous one.

Parameters
shapeThe shape of the array.

◆ ArrayXu8() [2/2]

IOLink.ArrayXu8.ArrayXu8 ( Indexer  indexer)
inline

Create an array with a memory layout fitting the given indexer.

Parameters
indexerthe Indexer instance describing the mmeory layout.

Member Function Documentation

◆ At()

byte IOLink.ArrayXu8.At ( VectorXu64  index)
inline

Get an element of the array.

If Array has an empty shape (dimension count = 0), this method has an undefined behavior.

Parameters
indexThe index of the element to get.

◆ Reshape()

void IOLink.ArrayXu8.Reshape ( VectorXu64  shape)
inline

Change the shape of the array.

Parameters
shapeThe new shape.

◆ SetAt()

void IOLink.ArrayXu8.SetAt ( VectorXu64  index,
byte  value 
)
inline

Set a value to an element of the array.

If Array has an empty shape (dimension count = 0), this method has an undefined behavior.

Parameters
indexThe index of the element to set.
valueThe value to set at the given index.

The documentation for this class was generated from the following file: