CPTNumericDataType.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	CPTNumericDataType
	Structure that describes the encoding of numeric data samples. More...

Enumerations
enum	CPTDataTypeFormat : NSInteger {   CPTUndefinedDataType = 0, CPTIntegerDataType, CPTUnsignedIntegerDataType, CPTFloatingPointDataType,   CPTComplexFloatingPointDataType, CPTDecimalDataType }
	Enumeration of data formats for numeric data. More...
enum	CPTDataOrder : NSInteger { CPTDataOrderRowsFirst, CPTDataOrderColumnsFirst }
	Enumeration of memory arrangements for multi-dimensional data arrays. More...

Functions
Data Type Utilities
CPTNumericDataType	CPTDataType (CPTDataTypeFormat format, size_t sampleBytes, CFByteOrder byteOrder)
	Initializes a CPTNumericDataType struct with the given parameter values. More...
CPTNumericDataType	CPTDataTypeWithDataTypeString (NSString *__nonnull dataTypeString)
	Initializes a CPTNumericDataType struct from a data type string. More...
NSString *__nonnull	CPTDataTypeStringFromDataType (CPTNumericDataType dataType)
	Generates a string representation of the given data type. More...
BOOL	CPTDataTypeIsSupported (CPTNumericDataType format)
	Validates a data type format. More...
BOOL	CPTDataTypeEqualToDataType (CPTNumericDataType dataType1, CPTNumericDataType dataType2)
	Compares two data types for equality. More...

Enumeration Type Documentation

CPTDataOrder

enum CPTDataOrder : NSInteger

Enumeration of memory arrangements for multi-dimensional data arrays.

See also

See Wikipedia for more information.

Enumerator
CPTDataOrderRowsFirst	Numeric data is arranged in row-major order.
CPTDataOrderColumnsFirst	Numeric data is arranged in column-major order.

CPTDataTypeFormat

enum CPTDataTypeFormat : NSInteger

Enumeration of data formats for numeric data.

Enumerator
CPTUndefinedDataType	Undefined.
CPTIntegerDataType	Integer.
CPTUnsignedIntegerDataType	Unsigned integer.
CPTFloatingPointDataType	Floating point.
CPTComplexFloatingPointDataType	Complex floating point.
CPTDecimalDataType	NSDecimal.

Function Documentation

CPTDataType()

CPTNumericDataType CPTDataType	(	CPTDataTypeFormat	format,
		size_t	sampleBytes,
		CFByteOrder	byteOrder
	)

Initializes a CPTNumericDataType struct with the given parameter values.

Parameters

format	The data type format.
sampleBytes	The number of bytes in each sample.
byteOrder	The byte order used to store the data samples.

Returns

The initialized CPTNumericDataType struct.

CPTDataTypeEqualToDataType()

BOOL CPTDataTypeEqualToDataType	(	CPTNumericDataType	dataType1,
		CPTNumericDataType	dataType2
	)

Compares two data types for equality.

Parameters

dataType1	The first data type format.
dataType2	The second data type format.

Returns

Returns YES if the two data types have the same format, size, and byte order.

CPTDataTypeIsSupported()

BOOL CPTDataTypeIsSupported

(

CPTNumericDataType

format

)

Validates a data type format.

Parameters

format

The data type format.

Returns

Returns YES if the format is supported by CPTNumericData, NO otherwise.

CPTDataTypeStringFromDataType()

NSString* __nonnull CPTDataTypeStringFromDataType

(

CPTNumericDataType

dataType

)

Generates a string representation of the given data type.

Parameters

dataType

The data type.

Returns

The string representation of the given data type.

CPTDataTypeWithDataTypeString()

CPTNumericDataType CPTDataTypeWithDataTypeString

(

NSString *__nonnull

dataTypeString

)

Initializes a CPTNumericDataType struct from a data type string.

Parameters

dataTypeString

The data type string.

Returns

The initialized CPTNumericDataType struct.