AMD rocAL - Parameter API

AMD rocAL - Parameter API#

rocAL: API: AMD rocAL - Parameter API
API: AMD rocAL - Parameter API

The AMD rocAL Parameters. More...

Functions

void ROCAL_API_CALL rocalSetSeed (unsigned seed)
 set seed for random number generation More...
 
unsigned ROCAL_API_CALL rocalGetSeed ()
 gets the seed value More...
 
RocalIntParam ROCAL_API_CALL rocalCreateIntUniformRand (int start, int end)
 Creates a new uniform random integer parameter within a specified range. More...
 
RocalStatus ROCAL_API_CALL rocalUpdateIntUniformRand (int start, int end, RocalIntParam updating_obj)
 updates uniform random integer parameter within a specified range. More...
 
int ROCAL_API_CALL rocalGetIntValue (RocalIntParam obj)
 gets the value of a RocalIntParam. More...
 
float ROCAL_API_CALL rocalGetFloatValue (RocalFloatParam obj)
 gets the value of a RocalFloatParam. More...
 
RocalFloatParam ROCAL_API_CALL rocalCreateFloatUniformRand (float start, float end)
 Creates a new uniform random float parameter within a specified range. More...
 
RocalFloatParam ROCAL_API_CALL rocalCreateFloatParameter (float val)
 Creates a new float parameter with a specified value. More...
 
RocalIntParam ROCAL_API_CALL rocalCreateIntParameter (int val)
 Creates a new int parameter with a specified value. More...
 
RocalStatus ROCAL_API_CALL rocalUpdateFloatParameter (float new_val, RocalFloatParam input_obj)
 Updates a float parameter with a new value. More...
 
RocalStatus ROCAL_API_CALL rocalUpdateIntParameter (int new_val, RocalIntParam input_obj)
 Updates a integer parameter with a new value. More...
 
RocalStatus ROCAL_API_CALL rocalUpdateFloatUniformRand (float start, float end, RocalFloatParam updating_obj)
 updates uniform random float parameter within a specified range. More...
 
RocalIntParam ROCAL_API_CALL rocalCreateIntRand (const int *values, const double *frequencies, unsigned size)
 Sets the parameters for a new or existing RocalIntRandGen object. More...
 
RocalStatus ROCAL_API_CALL rocalUpdateIntRand (const int *values, const double *frequencies, unsigned size, RocalIntParam updating_obj)
 update the int random value More...
 
RocalFloatParam ROCAL_API_CALL rocalCreateFloatRand (const float *values, const double *frequencies, unsigned size)
 Sets the parameters for a new or existing RocalFloatRandGen object. More...
 
RocalStatus ROCAL_API_CALL rocalUpdateFloatRand (const float *values, const double *frequencies, unsigned size, RocalFloatParam updating_obj)
 update the float random value More...
 

Detailed Description

The AMD rocAL Parameters.

Function Documentation

◆ rocalCreateFloatParameter()

RocalFloatParam ROCAL_API_CALL rocalCreateFloatParameter ( float  val)

Creates a new float parameter with a specified value.

Parameters
[in]valvalue to create float param
Returns
A new RocalFloatParam representing the float parameter.

◆ rocalCreateFloatRand()

RocalFloatParam ROCAL_API_CALL rocalCreateFloatRand ( const float *  values,
const double *  frequencies,
unsigned  size 
)

Sets the parameters for a new or existing RocalFloatRandGen object.

Parameters
[in]valuesrandom float values
[in]frequenciesfrequencies of the values
sizesize of the array
Returns
random float parameter

◆ rocalCreateFloatUniformRand()

RocalFloatParam ROCAL_API_CALL rocalCreateFloatUniformRand ( float  start,
float  end 
)

Creates a new uniform random float parameter within a specified range.

Parameters
startstart value of the float range
endend value of the float range
Returns
RocalFloatParam representing the uniform random float parameter.

◆ rocalCreateIntParameter()

RocalIntParam ROCAL_API_CALL rocalCreateIntParameter ( int  val)

Creates a new int parameter with a specified value.

Parameters
[in]valvalue to create integer param
Returns
A new RocalIntParam representing the integer parameter.

◆ rocalCreateIntRand()

RocalIntParam ROCAL_API_CALL rocalCreateIntRand ( const int *  values,
const double *  frequencies,
unsigned  size 
)

Sets the parameters for a new or existing RocalIntRandGen object.

Parameters
[in]valuesrandom int values
[in]frequenciesfrequencies of the values
sizesize of the array
Returns
random int paraeter

◆ rocalCreateIntUniformRand()

RocalIntParam ROCAL_API_CALL rocalCreateIntUniformRand ( int  start,
int  end 
)

Creates a new uniform random integer parameter within a specified range.

Parameters
startstart value of the integer range
endend value of the integer range
Returns
RocalIntParam representing the uniform random integer parameter.

◆ rocalGetFloatValue()

float ROCAL_API_CALL rocalGetFloatValue ( RocalFloatParam  obj)

gets the value of a RocalFloatParam.

Parameters
[in]objThe RocalFloatParam from which to retrieve the value.
Returns
float value of the RocalIntParam.

◆ rocalGetIntValue()

int ROCAL_API_CALL rocalGetIntValue ( RocalIntParam  obj)

gets the value of a RocalIntParam.

Parameters
[in]objThe RocalIntParam from which to retrieve the value.
Returns
integer value of the RocalIntParam.

◆ rocalGetSeed()

unsigned ROCAL_API_CALL rocalGetSeed ( )

gets the seed value

Returns
seed value

◆ rocalSetSeed()

void ROCAL_API_CALL rocalSetSeed ( unsigned  seed)

set seed for random number generation

Parameters
[in]seedseed for the random number generation

◆ rocalUpdateFloatParameter()

RocalStatus ROCAL_API_CALL rocalUpdateFloatParameter ( float  new_val,
RocalFloatParam  input_obj 
)

Updates a float parameter with a new value.

Parameters
[in]new_valThe new value to update the float parameter.
[in]input_objThe RocalFloatParam to be updated.
Returns
RocalStatus value.

◆ rocalUpdateFloatRand()

RocalStatus ROCAL_API_CALL rocalUpdateFloatRand ( const float *  values,
const double *  frequencies,
unsigned  size,
RocalFloatParam  updating_obj 
)

update the float random value

Parameters
[in]valuesrandom float values
[in]frequenciesfrequencies of the values
[in]sizesize of the array
[in]updating_objRocal Float Param to update
Returns
rocal status value

◆ rocalUpdateFloatUniformRand()

RocalStatus ROCAL_API_CALL rocalUpdateFloatUniformRand ( float  start,
float  end,
RocalFloatParam  updating_obj 
)

updates uniform random float parameter within a specified range.

Parameters
startstart value of the float range
endstart value of the float range
input_objRocalFloatParam to be updated.
Returns
rocal status value

◆ rocalUpdateIntParameter()

RocalStatus ROCAL_API_CALL rocalUpdateIntParameter ( int  new_val,
RocalIntParam  input_obj 
)

Updates a integer parameter with a new value.

Parameters
[in]new_valThe new value to update the integer parameter.
[in]input_objThe RocalIntParam to be updated.
Returns
RocalStatus value.

◆ rocalUpdateIntRand()

RocalStatus ROCAL_API_CALL rocalUpdateIntRand ( const int *  values,
const double *  frequencies,
unsigned  size,
RocalIntParam  updating_obj 
)

update the int random value

Parameters
[in]valuesrandom int values
[in]frequenciesfrequencies of the values
[in]sizesize of the array
[in]updating_objRocal int Param to update
Returns
rocal status value

◆ rocalUpdateIntUniformRand()

RocalStatus ROCAL_API_CALL rocalUpdateIntUniformRand ( int  start,
int  end,
RocalIntParam  updating_obj 
)

updates uniform random integer parameter within a specified range.

Parameters
startstart value of the integer range
endstart value of the integer range
input_objRocalIntParam to be updated.
Returns
rocal status value