Yeppp!
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Enumerations
yepTypes.h: common Yeppp! data types.

Data Structures

struct  Yep16fc
 Complex half-precision (16-bit) IEEE floating point type. More...
 
struct  Yep32fc
 Complex single-precision (32-bit) IEEE floating point type. More...
 
struct  Yep64fc
 Complex double-precision (64-bit) IEEE floating point type. More...
 
struct  Yep32df
 Dual single-precision (32-bit) IEEE floating point type. More...
 
struct  Yep64df
 Dual double-precision (64-bit) IEEE floating point type. More...
 
struct  Yep128u
 128-bit unsigned integer type. More...
 
struct  Yep128s
 128-bit signed integer type. More...
 

Enumerations

enum  YepStatus {
  YepStatusOk = 0, YepStatusNullPointer = 1, YepStatusMisalignedPointer = 2, YepStatusInvalidArgument = 3,
  YepStatusInvalidData = 4, YepStatusInvalidState = 5, YepStatusUnsupportedHardware = 6, YepStatusUnsupportedSoftware = 7,
  YepStatusInsufficientBuffer = 8, YepStatusOutOfMemory = 9, YepStatusSystemError = 10, YepStatusAccessDenied = 11
}
 Indicates success or failure of Yeppp! functions. More...
 

Integral types

typedef uint8_t Yep8u
 8-bit unsigned integer type.
 
typedef uint16_t Yep16u
 16-bit unsigned integer type.
 
typedef uint32_t Yep32u
 32-bit unsigned integer type.
 
typedef uint64_t Yep64u
 64-bit unsigned integer type.
 
typedef int8_t Yep8s
 8-bit signed integer type.
 
typedef int16_t Yep16s
 16-bit signed integer type.
 
typedef int32_t Yep32s
 32-bit signed integer type.
 
typedef int64_t Yep64s
 64-bit signed integer type.
 
typedef size_t YepSize
 Unsigned integer type of pointer width. More...
 
typedef compiler_specific< half > Yep16f
 Half-precision (16-bit) IEEE floating point type.
 
typedef float Yep32f
 Single-precision (32-bit) IEEE floating point type.
 
typedef double Yep64f
 Double-precision (64-bit) IEEE floating point type.
 
typedef compiler_specific
< long double > 
Yep80f
 Extended-precision (80-bit) IEEE floating point type.
 
typedef compiler_specific< bool > YepBoolean
 Boolean type. More...
 
#define YepBooleanTrue   true
 Boolean true value.
 
#define YepBooleanFalse   false
 Boolean false value.
 

Detailed Description


Data Structure Documentation

struct Yep16fc

Complex half-precision (16-bit) IEEE floating point type.

Data Fields

Yep16f re
 Real part of the complex number.
 
Yep16f im
 Imaginary part of the complex number.
 
struct Yep32fc

Complex single-precision (32-bit) IEEE floating point type.

Data Fields

Yep32f re
 Real part of the complex number.
 
Yep32f im
 Imaginary part of the complex number.
 
struct Yep64fc

Complex double-precision (64-bit) IEEE floating point type.

Data Fields

Yep64f re
 Real part of the complex number.
 
Yep64f im
 Imaginary part of the complex number.
 
struct Yep32df

Dual single-precision (32-bit) IEEE floating point type.

A number of this type is represented as an unevaluated sum of two Yep32f numbers.

Data Fields

Yep32f high
 
Yep32f low
 
struct Yep64df

Dual double-precision (64-bit) IEEE floating point type.

A number of this type is represented as an unevaluated sum of two Yep64f numbers.

Data Fields

Yep64f high
 
Yep64f low
 
struct Yep128u

128-bit unsigned integer type.

Data Fields

Yep64u low
 
Yep64u high
 
struct Yep128s

128-bit signed integer type.

Data Fields

Yep64u low
 
Yep64s high
 

Typedef Documentation

typedef size_t YepSize

Unsigned integer type of pointer width.

YepSize is 64-bit wide on systems with 64-bit pointers and 32-bit wide on systems with 32-bit pointers.

typedef compiler_specific<bool> YepBoolean

Boolean type.

The only valid values for YepBoolean type are YepBooleanTrue and YepBooleanFalse.

Enumeration Type Documentation

enum YepStatus

Indicates success or failure of Yeppp! functions.

Enumerator
YepStatusOk 

Operation finished successfully.

YepStatusNullPointer 

Function call failed because one of the pointer arguments is null.

YepStatusMisalignedPointer 

Function call failed because one of the pointer arguments is not properly aligned.

YepStatusInvalidArgument 

Function call failed because one of the integer arguments has unsupported value.

YepStatusInvalidData 

Function call failed because some of the data passed to the function has invalid format or values.

YepStatusInvalidState 

Function call failed because one of the state objects passed is corrupted.

YepStatusUnsupportedHardware 

Function call failed because the system hardware does not support the requested operation.

YepStatusUnsupportedSoftware 

Function call failed because the operating system does not support the requested operation.

YepStatusInsufficientBuffer 

Function call failed because the provided output buffer is too small or exhausted.

YepStatusOutOfMemory 

Function call failed because the library could not allocate the memory.

YepStatusSystemError 

Function call failed because some of the system calls inside the function failed.

YepStatusAccessDenied 

Function call failed because access to the requested resource is not allowed for this user.