/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/latest/rocAL/include/api/rocal_api_parameters.h Source File

• rocAL
• include
• api

rocal_api_parameters.h

Go to the documentation of this file.

1 /*

2 Copyright (c) 2019 - 2023 Advanced Micro Devices, Inc. All rights reserved.

3 

4 Permission is hereby granted, free of charge, to any person obtaining a copy

5 of this software and associated documentation files (the "Software"), to deal

6 in the Software without restriction, including without limitation the rights

7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

8 copies of the Software, and to permit persons to whom the Software is

9 furnished to do so, subject to the following conditions:

10 

11 The above copyright notice and this permission notice shall be included in

12 all copies or substantial portions of the Software.

13 

14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

20 THE SOFTWARE.

21 */

22 

23 #ifndef MIVISIONX_ROCAL_API_PARAMETERS_H

24 #define MIVISIONX_ROCAL_API_PARAMETERS_H

25 #include "rocal_api_types.h"

26 

39 extern "C" void ROCAL_API_CALL rocalSetSeed(unsigned seed);

40 

45 extern "C" unsigned ROCAL_API_CALL rocalGetSeed();

46 

53 extern "C" RocalIntParam ROCAL_API_CALL rocalCreateIntUniformRand(int start, int end);

54 

62 extern "C" RocalStatus ROCAL_API_CALL rocalUpdateIntUniformRand(int start, int end, RocalIntParam updating_obj);

63 

69 extern "C" int ROCAL_API_CALL rocalGetIntValue(RocalIntParam obj);

70 

76 extern "C" float ROCAL_API_CALL rocalGetFloatValue(RocalFloatParam obj);

77 

84 extern "C" RocalFloatParam ROCAL_API_CALL rocalCreateFloatUniformRand(float start, float end);

85 

91 extern "C" RocalFloatParam ROCAL_API_CALL rocalCreateFloatParameter(float val);

92 

98 extern "C" RocalIntParam ROCAL_API_CALL rocalCreateIntParameter(int val);

99 

106 extern "C" RocalStatus ROCAL_API_CALL rocalUpdateFloatParameter(float new_val, RocalFloatParam input_obj);

107 

114 extern "C" RocalStatus ROCAL_API_CALL rocalUpdateIntParameter(int new_val, RocalIntParam input_obj);

115 

123 extern "C" RocalStatus ROCAL_API_CALL rocalUpdateFloatUniformRand(float start, float end, RocalFloatParam updating_obj);

124 

132 extern "C" RocalIntParam ROCAL_API_CALL rocalCreateIntRand(const int *values, const double *frequencies, unsigned size);

133 

142 extern "C" RocalStatus ROCAL_API_CALL rocalUpdateIntRand(const int *values, const double *frequencies, unsigned size, RocalIntParam updating_obj);

143 

151 extern "C" RocalFloatParam ROCAL_API_CALL rocalCreateFloatRand(const float *values, const double *frequencies, unsigned size);

152 

161 extern "C" RocalStatus ROCAL_API_CALL rocalUpdateFloatRand(const float *values, const double *frequencies, unsigned size, RocalFloatParam updating_obj);

162 

163 #endif // MIVISIONX_ROCAL_API_PARAMETERS_H

rocalCreateFloatUniformRand

RocalFloatParam ROCAL_API_CALL rocalCreateFloatUniformRand(float start, float end)

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

rocalCreateIntUniformRand

RocalIntParam ROCAL_API_CALL rocalCreateIntUniformRand(int start, int end)

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

rocalUpdateIntUniformRand

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

updates uniform random integer parameter within a specified range.

rocalGetIntValue

int ROCAL_API_CALL rocalGetIntValue(RocalIntParam obj)

gets the value of a RocalIntParam.

rocalUpdateFloatParameter

RocalStatus ROCAL_API_CALL rocalUpdateFloatParameter(float new_val, RocalFloatParam input_obj)

Updates a float parameter with a new value.

rocalCreateIntParameter

RocalIntParam ROCAL_API_CALL rocalCreateIntParameter(int val)

Creates a new int parameter with a specified value.

rocalUpdateIntParameter

RocalStatus ROCAL_API_CALL rocalUpdateIntParameter(int new_val, RocalIntParam input_obj)

Updates a integer parameter with a new value.

rocalUpdateFloatUniformRand

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

updates uniform random float parameter within a specified range.

rocalGetFloatValue

float ROCAL_API_CALL rocalGetFloatValue(RocalFloatParam obj)

gets the value of a RocalFloatParam.

rocalSetSeed

void ROCAL_API_CALL rocalSetSeed(unsigned seed)

set seed for random number generation

rocalUpdateIntRand

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

update the int random value

rocalCreateIntRand

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

Sets the parameters for a new or existing RocalIntRandGen object.

rocalGetSeed

unsigned ROCAL_API_CALL rocalGetSeed()

gets the seed value

rocalUpdateFloatRand

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

update the float random value

rocalCreateFloatParameter

RocalFloatParam ROCAL_API_CALL rocalCreateFloatParameter(float val)

Creates a new float parameter with a specified value.

rocalCreateFloatRand

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

Sets the parameters for a new or existing RocalFloatRandGen object.

RocalStatus

RocalStatus

rocAL Status enum

Definition: rocal_api_types.h:112

RocalIntParam

void * RocalIntParam

typedef void* rocAL Int Param

Definition: rocal_api_types.h:58

RocalFloatParam

void * RocalFloatParam

typedef void* Float Param

Definition: rocal_api_types.h:53

rocal_api_types.h

The AMD rocAL Library - Types.

ROCAL_API_CALL

#define ROCAL_API_CALL

Definition: rocal_api_types.h:35