Function CDM_CreateVectors


Definition:#include <CDM.h>
Prototype:CDM_ByteSequenceSet CDM_CreateVectors(CDM_Document Document, const char *VectorAnnotation, const char *VectorAnnConstraints, const char *VectorFormat, const char *ClassAnnotation, const char *ClassAttribute, const char *ClassAttributeAbsenceValue, const char *ClassFail, int ClassCanContain, int ClassPrefixStartMode, int ClassPrefixEndMode, const char *ClassPrefixStart, const char *ClassPrefixEnd, int CellNumber, const CDM_CreateVectorsCellSpec CellSpec[], const char *StatusWindow);
Arguments:

Document: A Document object. (CDM_Document)
VectorAnnotation: The Annotation from which vectors will be created. (const char *)
VectorAnnConstraints: The Annotation from which vectors will be created. (const char *)
VectorFormat: The Annotation from which vectors will be created. (const char *)
ClassAnnotation: The Annotation from which vectors will be created. (const char *)
ClassAttribute: The Annotation from which vectors will be created. (const char *)
ClassAttributeAbsenceValue: The value to be used if the Class Attribute is not found (char *)
ClassFail: The Annotation from which vectors will be created. (const char *)
ClassCanContain: The Annotation from which vectors will be created. (const char *)
ClassPrefixStartMode: The Annotation from which vectors will be created. (const char *)
ClassPrefixEndMode: The Annotation from which vectors will be created. (const char *)
ClassPrefixStart: The Annotation from which vectors will be created. (const char *)
ClassPrefixEnd: The Annotation from which vectors will be created. (const char *)
CellNumber: The Annotation from which vectors will be created. (const char *)
CellSpec: The Annotation from which vectors will be created. (const char *)
StatusWindow: The Annotation from which vectors will be created. (const char *)

C/C++ API Sections
Tcl API Sections
Description
Return Value
Notes
See Also
Index

Description:

This function will create a set of vectors (for uses like instrumenting a machine learning algorithm for example) based on a wide range of information provided by the various parameters.

The return value of this function will be NULL if an error has occured, or a newly created object (of type CDM_ByteSequenceSet) which will contain the generated vectors if everything went as expected. Note that CDM does not owns the returned object: the caller is responsible to use CDM_Free of Tcl_DecrRefCount on the object if it is not needed any more.

The vectors in the returned object will be stored as a set of sets of text objects (of type CDM_ByteSequence or equivalent CDM_RawData). The caller must use CDM_SetGetElements on the restured object in order to get the individual vectors (each one encoded as a set of text objects of type CDM_ByteSequenceSet or CDM_RawDataSet or CDM_Set). Applying CDM_SetGetElements on a vector object, the individual text elements of the vector can be accessed.

Return Value:

The return value from this function will be a set of vectors, or NULL if an error has been occured. In case of an error, an error message describing the error will be left at the current active Tcl interpreter (CDM_Interp).

Notes:

This function is equivelant to tip_CreateVectors (Tcl API).

See Also:

CDM_SetGetElements, tip_CreateVectors


Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.