ILGPU  0.9.0
ILGPU.Backends.EntryPoints.EntryPointDescription Struct Reference

Specifies an entry point method including its associated index type. More...

Inheritance diagram for ILGPU.Backends.EntryPoints.EntryPointDescription:

Public Member Functions

void Validate ()
 Validates this object and throws a NotSupportedException in the case of an unsupported kernel configuration. More...
 
bool Equals (EntryPointDescription other)
 Returns true if the given description is equal to the current one. More...
 
override bool Equals (object obj)
 Returns true if the given object is equal to the current one. More...
 
override int GetHashCode ()
 Returns the hash code of this object. More...
 
override string ToString ()
 Returns the string representation of this object. More...
 

Static Public Member Functions

static EntryPointDescription FromExplicitlyGroupedKernel (MethodInfo methodSource)
 Creates a new entry point description from the given method source that is compatible with explicitly grouped kernels. More...
 
static EntryPointDescription FromImplicitlyGroupedKernel (MethodInfo methodSource)
 Creates a new entry point description from the given method source that is compatible with implicitly grouped kernels. More...
 
static bool operator== (EntryPointDescription left, EntryPointDescription right)
 Returns true if the left and right descriptions are the same. More...
 
static bool operator!= (EntryPointDescription left, EntryPointDescription right)
 Returns true if the left and right descriptions are not the same. More...
 

Public Attributes

bool HasSpecializedParameters => Parameters.HasSpecializedParameters
 Returns true if this entry point uses specialized parameters. More...
 

Properties

MethodInfo MethodSource [get]
 Returns the kernel method. More...
 
IndexType IndexType [get]
 Returns the associated index type. More...
 
ParameterCollection Parameters [get]
 Returns all parameters. More...
 
int KernelIndexParameterOffset [get]
 Returns the offset for the actual parameter values while taking an implicit index argument into account. More...
 

Detailed Description

Specifies an entry point method including its associated index type.

Member Function Documentation

bool ILGPU.Backends.EntryPoints.EntryPointDescription.Equals ( EntryPointDescription  other)

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

Parameters
otherThe other description.
Returns
True, if the given cached key is equal to the current one.
override bool ILGPU.Backends.EntryPoints.EntryPointDescription.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.
static EntryPointDescription ILGPU.Backends.EntryPoints.EntryPointDescription.FromExplicitlyGroupedKernel ( MethodInfo  methodSource)
static

Creates a new entry point description from the given method source that is compatible with explicitly grouped kernels.

Parameters
methodSourceThe kernel method source.
Returns
The created entry point description.
static EntryPointDescription ILGPU.Backends.EntryPoints.EntryPointDescription.FromImplicitlyGroupedKernel ( MethodInfo  methodSource)
static

Creates a new entry point description from the given method source that is compatible with implicitly grouped kernels.

Parameters
methodSourceThe kernel method source.
Returns
The created entry point description.
override int ILGPU.Backends.EntryPoints.EntryPointDescription.GetHashCode ( )

Returns the hash code of this object.

Returns
The hash code of this object.
static bool ILGPU.Backends.EntryPoints.EntryPointDescription.operator!= ( EntryPointDescription  left,
EntryPointDescription  right 
)
static

Returns true if the left and right descriptions are not the same.

Parameters
leftThe left description.
rightThe right description.
Returns
True, if the left and right descriptions are not the same.
static bool ILGPU.Backends.EntryPoints.EntryPointDescription.operator== ( EntryPointDescription  left,
EntryPointDescription  right 
)
static

Returns true if the left and right descriptions are the same.

Parameters
leftThe left description.
rightThe right description.
Returns
True, if the left and right descriptions are the same.
override string ILGPU.Backends.EntryPoints.EntryPointDescription.ToString ( )

Returns the string representation of this object.

Returns
The string representation of this object.
void ILGPU.Backends.EntryPoints.EntryPointDescription.Validate ( )

Validates this object and throws a NotSupportedException in the case of an unsupported kernel configuration.

Member Data Documentation

bool ILGPU.Backends.EntryPoints.EntryPointDescription.HasSpecializedParameters => Parameters.HasSpecializedParameters

Returns true if this entry point uses specialized parameters.

Property Documentation

IndexType ILGPU.Backends.EntryPoints.EntryPointDescription.IndexType
get

Returns the associated index type.

int ILGPU.Backends.EntryPoints.EntryPointDescription.KernelIndexParameterOffset
get

Returns the offset for the actual parameter values while taking an implicit index argument into account.

MethodInfo ILGPU.Backends.EntryPoints.EntryPointDescription.MethodSource
get

Returns the kernel method.

ParameterCollection ILGPU.Backends.EntryPoints.EntryPointDescription.Parameters
get

Returns all parameters.


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