Mac Dev Center Mac OS X Reference Library Data Management: Strings, Text, & Fonts Latent Semantic Mapping Reference

Overview

Semantic Mapping This framework classifies texts based on latent semantic information.

Functions

LSMMapAddCategory

LSMMapAddText

LSMMapAddTextWithWeight

LSMMapApplyClusters

LSMMapCompile

LSMMapCreate

LSMMapCreateClusters

LSMMapCreateFromURL

LSMMapGetCategoryCount

LSMMapGetProperties

LSMMapGetTypeID

LSMMapSetProperties

LSMMapSetStopWords

LSMMapStartTraining

LSMMapWriteToStream

LSMMapWriteToURL

LSMResultCopyToken

LSMResultCopyTokenCluster

LSMResultCopyWord

LSMResultCopyWordCluster

LSMResultCreate

LSMResultGetCategory

LSMResultGetCount

LSMResultGetScore

LSMResultGetTypeID

LSMTextAddToken

LSMTextAddWord

LSMTextAddWords

LSMTextCreate

LSMTextGetTypeID

LSMCategory LSMMapAddCategory(
    LSMMapRef mapref);  

Discussion

Adds another category and returns its category identifier.

OSStatus LSMMapAddText(
    LSMMapRef mapref,
    LSMTextRef textref,
    LSMCategory category);  

Discussion

Adds a training text to the given category. The textref is no longer needed after this call.

OSStatus LSMMapAddTextWithWeight(
    LSMMapRef mapref,
    LSMTextRef textref,
    LSMCategory category,
    float weight);  

Discussion

Adds a training text to the given category with a weight different from 1. The weight may be negative, but global counts will be pinned to 0. The textref is no longer needed after this call.

OSStatus LSMMapApplyClusters(
    LSMMapRef mapref,
    CFArrayRef clusters);  

Discussion

Group categories or words (tokens) into the specified sets of clusters.

OSStatus LSMMapCompile(
    LSMMapRef mapref);  

Discussion

Compiles the map into executable form and puts it into mapping mode, preparing it for the classification of texts. This function is computationally expensive.

LSMMapRef LSMMapCreate(
    CFAllocatorRef alloc,
    CFOptionFlags flags);  

Discussion

Creates a new LSM map. Call CFRelease to dispose.

CFArrayRef LSMMapCreateClusters(
    CFAllocatorRef alloc, 
    LSMMapRef mapref,
    CFArrayRef subset, 
    CFIndex numClusters,
    CFOptionFlags flags);  

Discussion

Compute a set of clusters grouping similar categories or words. If subset is non-NULL, only perform clustering on the categories or words listed.

LSMMapRef LSMMapCreateFromURL(
    CFAllocatorRef alloc,
    CFURLRef file, 
    CFOptionFlags flags);  

Discussion

Loads a map from a given file.

CFIndex LSMMapGetCategoryCount(
    LSMMapRef mapref);  

Discussion

Returns the number of categories in the map.

CFDictionaryRef LSMMapGetProperties(
    LSMMapRef mapref);  

Discussion

Get a dictionary of properties for the map. LSM retains ownership of this dictionary, do not release it.

CFTypeID LSMMapGetTypeID(
    void);  

Discussion

Returns the Core Foundation type identifier for LSM maps.

void LSMMapSetProperties(
    LSMMapRef mapref,
    CFDictionaryRef properties);  

Discussion

Set a dictionary of properties for the map. LSM makes its own copy of the properties, there's no need to retain them past this call.

OSStatus LSMMapSetStopWords(
    LSMMapRef mapref,
    LSMTextRef textref);  

Discussion

The specified words will be omitted from all classification efforts. Needs to be called before any other texts are created. The textref is no longer needed after this call.

OSStatus LSMMapStartTraining(
    LSMMapRef mapref);  

Discussion

Puts the map into training mode, preparing it for the addition of more categories and/or texts. This function will be somewhat expensive, as it requires substantial data structure reorganization.

OSStatus LSMMapWriteToStream(
    LSMMapRef mapref,
    LSMTextRef textref, 
    CFWriteStreamRef stream,
    CFOptionFlags options);  

Discussion

Writes information about a map and/or text to a stream in text form

OSStatus LSMMapWriteToURL(
    LSMMapRef mapref,
    CFURLRef file,
    CFOptionFlags flags);  

Discussion

Compiles the map if necessary and then stores it into the given file.

CFDataRef LSMResultCopyToken(
    LSMResultRef mapref,
    CFIndex n);  

Discussion

Returns the token for the n-th best (zero based) result.

CFArrayRef LSMResultCopyTokenCluster(
    LSMResultRef mapref,
    CFIndex n);  

Discussion

Returns the cluster of tokens for the n-th best (zero based) result.

CFStringRef LSMResultCopyWord(
    LSMResultRef result,
    CFIndex n);  

Discussion

Returns the word for the n-th best (zero based) result.

CFArrayRef LSMResultCopyWordCluster(
    LSMResultRef result,
    CFIndex n);  

Discussion

Returns the cluster of words for the n-th best (zero based) result.

LSMResultRef LSMResultCreate(
    CFAllocatorRef alloc, 
    LSMMapRef mapref,
    LSMTextRef textref, 
    CFIndex numResults,
    CFOptionFlags flags);  

Discussion

Returns, in decreasing order of likelihood, the categories or words that best match when a text is mapped into a map.

LSMCategory LSMResultGetCategory(
    LSMResultRef result,
    CFIndex n);  

Discussion

Returns the category of the n-th best (zero based) result.

CFIndex LSMResultGetCount(
    LSMResultRef result);  

Discussion

Returns the number of results.

float LSMResultGetScore(
    LSMResultRef result,
    CFIndex n);  

Discussion

Returns the likelihood of the n-th best (zero based) result.

CFTypeID LSMResultGetTypeID(
    void);  

Discussion

Returns the Core Foundation type identifier for LSM results.

OSStatus LSMTextAddToken(
    LSMTextRef textref,
    CFDataRef token);  

Discussion

Adds an arbitrary binary token to the text. The order of tokens is significant if the map uses pairs or triplets, and the count of tokens is always significant.

OSStatus LSMTextAddWord(
    LSMTextRef textref,
    CFStringRef word);  

Discussion

Adds a word to the text. The order of words is significant if the map uses pairs or triplets, and the count of words is always significant.

OSStatus LSMTextAddWords(
    LSMTextRef textref,
    CFStringRef words, 
    CFLocaleRef locale,
    CFOptionFlags flags);  

Discussion

Breaks a string into words using the locale provided and adds the words to the text.

LSMTextRef LSMTextCreate(
    CFAllocatorRef alloc,
    LSMMapRef mapref);  

Discussion

Creates a new text.

CFTypeID LSMTextGetTypeID(
    void);  

Discussion

Returns the Core Foundation type identifier for LSM texts.

Typedefs

LSMCategory

LSMMapRef

LSMResult

LSMResultRef

LSMTextRef

typedef uint32_t LSMCategory;  

Discussion

An integral type representing a category.

typedef struct __LSMMap * LSMMapRef;  

Discussion

An opaque Core Foundation type representing an LSM map (mutable).

typedef struct __LSMResult * LSMResultRef;  

Discussion

An opaque Core Foundation type representing the result of a lookup (immutable).

typedef struct __LSMResult * LSMResultRef;  

Discussion

An opaque Core Foundation type representing the result of a lookup (immutable).

typedef struct __LSMText * LSMTextRef;  

Discussion

An opaque Core Foundation type representing an input text (mutable).

Enumerated Types

Error codes

Map Flags

Parsing Flags

Result Flags

Storage Flags

enum { 
    kLSMMapOutOfState = -6640, 
    kLSMMapNoSuchCategory = -6641, 
    kLSMMapWriteError = -6642, 
    kLSMMapBadPath = -6643, 
    kLSMMapBadCluster = -6644 
};  

Constants

Discussion

Errors returned from LSM routines

enum { 
    kLSMMapPairs = 1, 
    kLSMMapTriplets = 2,  
    kLSMMapHashText = 256 
};  

Constants

Discussion

Options that can be specified for LSMMapCreate. These options can improve mapping accuracy, at a potentially significant increase in memory use.

enum { 
    kLSMTextPreserveCase = 1, 
    kLSMTextPreserveAcronyms = 2, 
    kLSMTextApplySpamHeuristics = 4 
};  

Constants

Discussion

Options you can specify for LSMTextAddWords.

enum { 
    kLSMResultBestWords = 1, 
};  

Constants

Discussion

Options for LSMResultCreate.

enum { 
    kLSMMapDiscardCounts = 1, 
    kLSMMapLoadMutable = 2 
};  

Constants

Discussion

Options for LSMMap{CreateFrom,WriteTo}URL.

Macro Definitions

kLSMAlgorithmDense

kLSMAlgorithmKey

kLSMAlgorithmSparse

kLSMDimensionKey

kLSMIterationsKey

kLSMPrecisionDouble

kLSMPrecisionFloat

kLSMPrecisionKey

kLSMSweepAgeKey

kLSMSweepCutoffKey

#define kLSMAlgorithmDense CFSTR("LSMAlgorithmDense") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMAlgorithmKey CFSTR("LSMAlgorithm") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMAlgorithmSparse CFSTR("LSMAlgorithmSparse") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMDimensionKey CFSTR("LSMDimension") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMIterationsKey CFSTR("LSMIterations") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMPrecisionDouble CFSTR("LSMPrecisionDouble") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMPrecisionFloat CFSTR("LSMPrecisionFloat") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMPrecisionKey CFSTR("LSMPrecision") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMSweepAgeKey CFSTR("LSMSweepAge") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.

#define kLSMSweepCutoffKey CFSTR("LSMSweepCutoff") 

Discussion

A CFDictionary of arbitrary properties may be associated. with an LSM map. The following keys currently are interpreted by LSM, and all other keys starting with LSM... are reserved.