ILGPU  0.9.0
ILGPU.Util.Int2 Struct Reference

Represents a combined structure type to hold multiple primitive values of the same type. More...

Inheritance diagram for ILGPU.Util.Int2:

Public Member Functions

 Int2 (int value)
 Constructs a new data container. More...
 
 Int2 (int x, int y)
 Constructs a new data container. More...
 
 Int2 (DataBlock< int, int > block)
 Constructs a new data block. More...
 
int ToValueTuple ()
 
bool Equals (Int2 other)
 
override bool Equals (object obj)
 Returns true if the given object is equal to the current one. More...
 
override int GetHashCode ()
 Returns the combined hash code of all items. More...
 
override string ToString ()
 Returns the string representation of this view. More...
 

Static Public Member Functions

static Int2 operator* (Int2 left, Int2 right)
 Executes an arithmetic * operation on all elements. More...
 
static Int2 operator/ (Int2 left, Int2 right)
 Executes an arithmetic / operation on all elements. More...
 
static Int2 operator- (Int2 left, Int2 right)
 Executes an arithmetic - operation on all elements. More...
 
static Int2 operator+ (Int2 left, Int2 right)
 Executes an arithmetic + operation on all elements. More...
 
static implicit operator Int2 (int value)
 Converts the given single value into its container representation. More...
 
static implicit operator (int, int)(Int2 value)
 Converts the given value into its tuple representation. More...
 
static implicit operator DataBlock< int, int > (Int2 value)
 Converts the given value into its data block representation. More...
 
static bool operator== (Int2 left, Int2 right)
 Returns true if both data blocks represent the same elements. More...
 
static bool operator!= (Int2 left, Int2 right)
 Returns true if both data blocks do not represent the same elements. More...
 

Public Attributes

DataBlock< int, intDataBlock => dataBlock
 The underlying raw data block. More...
 
 int
 Returns a value tuple that stores all items. More...
 

Static Public Attributes

static readonly int ElementSize = Interop.SizeOf<Int2>()
 Represents the native size of a single element. More...
 

Properties

int X [get, set]
 Returns the i-th element. More...
 
int Y [get, set]
 Returns the i-th element. More...
 

Detailed Description

Represents a combined structure type to hold multiple primitive values of the same type.

Constructor & Destructor Documentation

ILGPU.Util.Int2.Int2 ( int  value)

Constructs a new data container.

ILGPU.Util.Int2.Int2 ( int  x,
int  y 
)

Constructs a new data container.

ILGPU.Util.Int2.Int2 ( DataBlock< int, int block)

Constructs a new data block.

Member Function Documentation

bool ILGPU.Util.Int2.Equals ( Int2  other)

override bool ILGPU.Util.Int2.Equals ( object  obj)

Returns true if the given object is equal to the current one.

Parameters
objThe other object.
Returns
True, if the given object is equal to the current one.
override int ILGPU.Util.Int2.GetHashCode ( )

Returns the combined hash code of all items.

Returns
The hash code of all items.
static implicit ILGPU.Util.Int2.operator ( int  ,
int   
)
static

Converts the given value into its tuple representation.

Parameters
valueThe value to convert.
static implicit ILGPU.Util.Int2.operator DataBlock< int, int > ( Int2  value)
static

Converts the given value into its data block representation.

Parameters
valueThe value to convert.
static implicit ILGPU.Util.Int2.operator Int2 ( int  value)
static

Converts the given single value into its container representation.

Parameters
valueThe value to convert.
static bool ILGPU.Util.Int2.operator!= ( Int2  left,
Int2  right 
)
static

Returns true if both data blocks do not represent the same elements.

Parameters
leftThe left block.
rightThe right block.
Returns
True, if both data block do not represent the same elements.
static Int2 ILGPU.Util.Int2.operator* ( Int2  left,
Int2  right 
)
static

Executes an arithmetic * operation on all elements.

Parameters
leftThe left operand.
rightThe right operand.
Returns
The resulting value.
static Int2 ILGPU.Util.Int2.operator+ ( Int2  left,
Int2  right 
)
static

Executes an arithmetic + operation on all elements.

Parameters
leftThe left operand.
rightThe right operand.
Returns
The resulting value.
static Int2 ILGPU.Util.Int2.operator- ( Int2  left,
Int2  right 
)
static

Executes an arithmetic - operation on all elements.

Parameters
leftThe left operand.
rightThe right operand.
Returns
The resulting value.
static Int2 ILGPU.Util.Int2.operator/ ( Int2  left,
Int2  right 
)
static

Executes an arithmetic / operation on all elements.

Parameters
leftThe left operand.
rightThe right operand.
Returns
The resulting value.
static bool ILGPU.Util.Int2.operator== ( Int2  left,
Int2  right 
)
static

Returns true if both data blocks represent the same elements.

Parameters
leftThe left block.
rightThe right block.
Returns
True, if both data block represent the same elements.
override string ILGPU.Util.Int2.ToString ( )

Returns the string representation of this view.

Returns
The string representation of this view.
int ILGPU.Util.Int2.ToValueTuple ( )

Member Data Documentation

DataBlock<int, int> ILGPU.Util.Int2.DataBlock => dataBlock

The underlying raw data block.

readonly int ILGPU.Util.Int2.ElementSize = Interop.SizeOf<Int2>()
static

Represents the native size of a single element.

ILGPU.Util.Int2.int

Returns a value tuple that stores all items.

Returns
The constructed value tuple.

Property Documentation

int ILGPU.Util.Int2.X
getset

Returns the i-th element.

int ILGPU.Util.Int2.Y
getset

Returns the i-th element.


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