ILGPU  0.9.0
ILGPU.Util.Short3 Struct Reference

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

Inheritance diagram for ILGPU.Util.Short3:

Public Member Functions

 Short3 (short value)
 Constructs a new data container. More...
 
 Short3 (short x, short y, short z)
 Constructs a new data container. More...
 
 Short3 (DataBlock< short, short, short > block)
 Constructs a new data block. More...
 
short ToValueTuple ()
 
bool Equals (Short3 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 Short3 operator* (Short3 left, Short3 right)
 Executes an arithmetic * operation on all elements. More...
 
static Short3 operator/ (Short3 left, Short3 right)
 Executes an arithmetic / operation on all elements. More...
 
static Short3 operator- (Short3 left, Short3 right)
 Executes an arithmetic - operation on all elements. More...
 
static Short3 operator+ (Short3 left, Short3 right)
 Executes an arithmetic + operation on all elements. More...
 
static implicit operator Short3 (short value)
 Converts the given single value into its container representation. More...
 
static implicit operator (short, short, short)(Short3 value)
 Converts the given value into its tuple representation. More...
 
static implicit operator DataBlock< short, short, short > (Short3 value)
 Converts the given value into its data block representation. More...
 
static bool operator== (Short3 left, Short3 right)
 Returns true if both data blocks represent the same elements. More...
 
static bool operator!= (Short3 left, Short3 right)
 Returns true if both data blocks do not represent the same elements. More...
 

Public Attributes

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

Static Public Attributes

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

Properties

short X [get, set]
 Returns the i-th element. More...
 
short Y [get, set]
 Returns the i-th element. More...
 
short Z [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.Short3.Short3 ( short  value)

Constructs a new data container.

ILGPU.Util.Short3.Short3 ( short  x,
short  y,
short  z 
)

Constructs a new data container.

ILGPU.Util.Short3.Short3 ( DataBlock< short, short, short block)

Constructs a new data block.

Member Function Documentation

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

override bool ILGPU.Util.Short3.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.Short3.GetHashCode ( )

Returns the combined hash code of all items.

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

Converts the given value into its tuple representation.

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

Converts the given value into its data block representation.

Parameters
valueThe value to convert.
static implicit ILGPU.Util.Short3.operator Short3 ( short  value)
static

Converts the given single value into its container representation.

Parameters
valueThe value to convert.
static bool ILGPU.Util.Short3.operator!= ( Short3  left,
Short3  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 Short3 ILGPU.Util.Short3.operator* ( Short3  left,
Short3  right 
)
static

Executes an arithmetic * operation on all elements.

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

Executes an arithmetic + operation on all elements.

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

Executes an arithmetic - operation on all elements.

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

Executes an arithmetic / operation on all elements.

Parameters
leftThe left operand.
rightThe right operand.
Returns
The resulting value.
static bool ILGPU.Util.Short3.operator== ( Short3  left,
Short3  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.Short3.ToString ( )

Returns the string representation of this view.

Returns
The string representation of this view.
short ILGPU.Util.Short3.ToValueTuple ( )

Member Data Documentation

DataBlock<short, short, short> ILGPU.Util.Short3.DataBlock => dataBlock

The underlying raw data block.

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

Represents the native size of a single element.

ILGPU.Util.Short3.short

Returns a value tuple that stores all items.

Returns
The constructed value tuple.

Property Documentation

short ILGPU.Util.Short3.X
getset

Returns the i-th element.

short ILGPU.Util.Short3.Y
getset

Returns the i-th element.

short ILGPU.Util.Short3.Z
getset

Returns the i-th element.


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