KkcLanguageModelMetadata

KkcLanguageModelMetadata

Functions

KkcLanguageModel * kkc_language_model_metadata_create_language_model ()
KkcLanguageModelMetadata * kkc_language_model_metadata_new ()
GType kkc_language_model_metadata_get_model_type ()
void kkc_language_model_metadata_set_model_type ()
KkcLanguageModelMetadata * kkc_language_model_metadata_find ()
GeeCollection * kkc_language_model_unigram_entries ()
GeeCollection * kkc_language_model_entries ()
KkcLanguageModelEntry * kkc_language_model_get ()
gboolean kkc_language_model_parse ()
KkcLanguageModelMetadata * kkc_language_model_get_metadata ()
void kkc_language_model_set_metadata ()
void kkc_language_model_get_bos ()
void kkc_language_model_get_eos ()
KkcLanguageModel * kkc_language_model_load ()
KkcLanguageModelEntry * kkc_language_model_entry_dup ()
void kkc_language_model_entry_free ()
void kkc_language_model_entry_copy ()
void kkc_language_model_entry_destroy ()
gdouble kkc_unigram_language_model_unigram_cost ()
gdouble kkc_unigram_language_model_unigram_backoff ()
gboolean kkc_bigram_language_model_has_bigram ()
gdouble kkc_bigram_language_model_bigram_cost ()
gdouble kkc_bigram_language_model_bigram_backoff ()
gdouble kkc_bigram_language_model_bigram_backoff_cost ()
gboolean kkc_trigram_language_model_has_trigram ()
gdouble kkc_trigram_language_model_trigram_cost ()
gdouble kkc_trigram_language_model_trigram_backoff_cost ()

Properties

GType * model-type Read / Write / Construct
KkcLanguageModelEntry * bos Read
KkcLanguageModelEntry * eos Read
KkcLanguageModelMetadata * metadata Read / Write / Construct

Types and Values

#define KKC_TYPE_LANGUAGE_MODEL_METADATA
struct KkcLanguageModelMetadata
struct KkcLanguageModelMetadataClass
#define KKC_TYPE_LANGUAGE_MODEL
struct KkcLanguageModel
struct KkcLanguageModelClass
enum KkcLanguageModelError
struct KkcLanguageModelEntry
  KkcUnigramLanguageModel
struct KkcUnigramLanguageModelIface
  KkcBigramLanguageModel
struct KkcBigramLanguageModelIface
  KkcTrigramLanguageModel
struct KkcTrigramLanguageModelIface

Object Hierarchy

    GBoxed
    ╰── KkcLanguageModelEntry
    GInterface
    ├── KkcBigramLanguageModel
    ├── KkcTrigramLanguageModel
    ╰── KkcUnigramLanguageModel
    GObject
    ├── KkcLanguageModel
    │   ├── KkcSortedBigramLanguageModel
    │   ╰── KkcTextBigramLanguageModel
    ╰── KkcMetadataFile
        ╰── KkcLanguageModelMetadata

Prerequisites

KkcUnigramLanguageModel requires KkcLanguageModel.

KkcBigramLanguageModel requires KkcUnigramLanguageModel and KkcLanguageModel.

KkcTrigramLanguageModel requires KkcBigramLanguageModel, KkcUnigramLanguageModel and KkcLanguageModel.

Known Derived Interfaces

KkcLanguageModel is required by KkcBigramLanguageModel, KkcTrigramLanguageModel and KkcUnigramLanguageModel.

KkcUnigramLanguageModel is required by KkcBigramLanguageModel and KkcTrigramLanguageModel.

KkcBigramLanguageModel is required by KkcTrigramLanguageModel.

Implemented Interfaces

KkcLanguageModelMetadata implements GInitable.

KkcLanguageModel implements GInitable.

Known Implementations

KkcUnigramLanguageModel is implemented by KkcSortedBigramLanguageModel, KkcSortedTrigramLanguageModel, KkcTextBigramLanguageModel and KkcTextTrigramLanguageModel.

KkcBigramLanguageModel is implemented by KkcSortedBigramLanguageModel, KkcSortedTrigramLanguageModel, KkcTextBigramLanguageModel and KkcTextTrigramLanguageModel.

KkcTrigramLanguageModel is implemented by KkcSortedTrigramLanguageModel and KkcTextTrigramLanguageModel.

Description

Functions

kkc_language_model_metadata_create_language_model ()

KkcLanguageModel *
kkc_language_model_metadata_create_language_model
                               (KkcLanguageModelMetadata *self,
                                GError **error);

Parameters

self

the KkcLanguageModelMetadata instance

  

error

location to store the error occuring, or NULL to ignore

  

kkc_language_model_metadata_new ()

KkcLanguageModelMetadata *
kkc_language_model_metadata_new (const gchar *name,
                                 const gchar *filename,
                                 GError **error);

Parameters

name

 

  

filename

 

  

error

location to store the error occuring, or NULL to ignore

  

kkc_language_model_metadata_get_model_type ()

GType
kkc_language_model_metadata_get_model_type
                               (KkcLanguageModelMetadata *self);

Get and return the current value of the "model-type" property.

Parameters

self

the KkcLanguageModelMetadata instance to query

  

Returns

the value of the "model-type" property

kkc_language_model_metadata_set_model_type ()

void
kkc_language_model_metadata_set_model_type
                               (KkcLanguageModelMetadata *self,
                                GType value);

Set the value of the "model-type" property to value .

Parameters

self

the KkcLanguageModelMetadata instance to modify

  

value

the new value of the "model-type" property

  

kkc_language_model_metadata_find ()

KkcLanguageModelMetadata *
kkc_language_model_metadata_find (const gchar *name);

Parameters

name

 

  

kkc_language_model_unigram_entries ()

GeeCollection *
kkc_language_model_unigram_entries (KkcLanguageModel *self,
                                    const gchar *input);

Parameters

self

the KkcLanguageModel instance

  

input

 

  

kkc_language_model_entries ()

GeeCollection *
kkc_language_model_entries (KkcLanguageModel *self,
                            const gchar *input);

Parameters

self

the KkcLanguageModel instance

  

input

 

  

kkc_language_model_get ()

KkcLanguageModelEntry *
kkc_language_model_get (KkcLanguageModel *self,
                        const gchar *input,
                        const gchar *output);

Parameters

self

the KkcLanguageModel instance

  

input

 

  

output

 

  

kkc_language_model_parse ()

gboolean
kkc_language_model_parse (KkcLanguageModel *self,
                          GError **error);

Parameters

self

the KkcLanguageModel instance

  

error

location to store the error occuring, or NULL to ignore

  

kkc_language_model_get_metadata ()

KkcLanguageModelMetadata *
kkc_language_model_get_metadata (KkcLanguageModel *self);

Get and return the current value of the "metadata" property.

Parameters

self

the KkcLanguageModel instance to query

  

Returns

the value of the "metadata" property

kkc_language_model_set_metadata ()

void
kkc_language_model_set_metadata (KkcLanguageModel *self,
                                 KkcLanguageModelMetadata *value);

Set the value of the "metadata" property to value .

Parameters

self

the KkcLanguageModel instance to modify

  

value

the new value of the "metadata" property

  

kkc_language_model_get_bos ()

void
kkc_language_model_get_bos (KkcLanguageModel *self,
                            KkcLanguageModelEntry *result);

Get and return the current value of the "bos" property.

Parameters

self

the KkcLanguageModel instance to query

  

Returns

the value of the "bos" property

kkc_language_model_get_eos ()

void
kkc_language_model_get_eos (KkcLanguageModel *self,
                            KkcLanguageModelEntry *result);

Get and return the current value of the "eos" property.

Parameters

self

the KkcLanguageModel instance to query

  

Returns

the value of the "eos" property

kkc_language_model_load ()

KkcLanguageModel *
kkc_language_model_load (const gchar *name,
                         GError **error);

Parameters

name

 

  

error

location to store the error occuring, or NULL to ignore

  

kkc_language_model_entry_dup ()

KkcLanguageModelEntry *
kkc_language_model_entry_dup (const KkcLanguageModelEntry *self);

Creates a copy of self.

See also: kkc_language_model_entry_copy(), kkc_language_model_entry_destroy(), kkc_language_model_entry_free()

Parameters

self

the instance to duplicate

  

Returns

a copy of self , free with kkc_language_model_entry_free()

kkc_language_model_entry_free ()

void
kkc_language_model_entry_free (KkcLanguageModelEntry *self);

Frees the heap-allocated struct.

See also: kkc_language_model_entry_dup(), kkc_language_model_entry_copy(), kkc_language_model_entry_destroy()

Parameters

self

the struct to free

  

kkc_language_model_entry_copy ()

void
kkc_language_model_entry_copy (const KkcLanguageModelEntry *self,
                               KkcLanguageModelEntry *dest);

Creates a copy of self.

See also: kkc_language_model_entry_dup(), kkc_language_model_entry_destroy(), kkc_language_model_entry_free()

Parameters

self

the struct to copy

  

dest

a unused struct. Use kkc_language_model_entry_destroy() to free the content.

  

kkc_language_model_entry_destroy ()

void
kkc_language_model_entry_destroy (KkcLanguageModelEntry *self);

Frees the content of the struct pointed by self .

See also: kkc_language_model_entry_dup(), kkc_language_model_entry_copy(), kkc_language_model_entry_free()

Parameters

self

the struct to destroy

  

kkc_unigram_language_model_unigram_cost ()

gdouble
kkc_unigram_language_model_unigram_cost
                               (KkcUnigramLanguageModel *self,
                                KkcLanguageModelEntry *entry);

Parameters

self

the KkcUnigramLanguageModel instance

  

entry

 

  

kkc_unigram_language_model_unigram_backoff ()

gdouble
kkc_unigram_language_model_unigram_backoff
                               (KkcUnigramLanguageModel *self,
                                KkcLanguageModelEntry *entry);

Parameters

self

the KkcUnigramLanguageModel instance

  

entry

 

  

kkc_bigram_language_model_has_bigram ()

gboolean
kkc_bigram_language_model_has_bigram (KkcBigramLanguageModel *self,
                                      KkcLanguageModelEntry *pentry,
                                      KkcLanguageModelEntry *entry);

Parameters

self

the KkcBigramLanguageModel instance

  

pentry

 

  

entry

 

  

kkc_bigram_language_model_bigram_cost ()

gdouble
kkc_bigram_language_model_bigram_cost (KkcBigramLanguageModel *self,
                                       KkcLanguageModelEntry *pentry,
                                       KkcLanguageModelEntry *entry);

Parameters

self

the KkcBigramLanguageModel instance

  

pentry

 

  

entry

 

  

kkc_bigram_language_model_bigram_backoff ()

gdouble
kkc_bigram_language_model_bigram_backoff
                               (KkcBigramLanguageModel *self,
                                KkcLanguageModelEntry *pentry,
                                KkcLanguageModelEntry *entry);

Parameters

self

the KkcBigramLanguageModel instance

  

pentry

 

  

entry

 

  

kkc_bigram_language_model_bigram_backoff_cost ()

gdouble
kkc_bigram_language_model_bigram_backoff_cost
                               (KkcBigramLanguageModel *self,
                                KkcLanguageModelEntry *pentry,
                                KkcLanguageModelEntry *entry);

Parameters

self

the KkcBigramLanguageModel instance

  

pentry

 

  

entry

 

  

kkc_trigram_language_model_has_trigram ()

gboolean
kkc_trigram_language_model_has_trigram
                               (KkcTrigramLanguageModel *self,
                                KkcLanguageModelEntry *ppentry,
                                KkcLanguageModelEntry *pentry,
                                KkcLanguageModelEntry *entry);

Parameters

self

the KkcTrigramLanguageModel instance

  

ppentry

 

  

pentry

 

  

entry

 

  

kkc_trigram_language_model_trigram_cost ()

gdouble
kkc_trigram_language_model_trigram_cost
                               (KkcTrigramLanguageModel *self,
                                KkcLanguageModelEntry *ppentry,
                                KkcLanguageModelEntry *pentry,
                                KkcLanguageModelEntry *entry);

Parameters

self

the KkcTrigramLanguageModel instance

  

ppentry

 

  

pentry

 

  

entry

 

  

kkc_trigram_language_model_trigram_backoff_cost ()

gdouble
kkc_trigram_language_model_trigram_backoff_cost
                               (KkcTrigramLanguageModel *self,
                                KkcLanguageModelEntry *ppentry,
                                KkcLanguageModelEntry *pentry,
                                KkcLanguageModelEntry *entry);

Parameters

self

the KkcTrigramLanguageModel instance

  

ppentry

 

  

pentry

 

  

entry

 

  

Types and Values

KKC_TYPE_LANGUAGE_MODEL_METADATA

#define KKC_TYPE_LANGUAGE_MODEL_METADATA (kkc_language_model_metadata_get_type ())

The type for KkcLanguageModelMetadata.

struct KkcLanguageModelMetadata

struct KkcLanguageModelMetadata;

struct KkcLanguageModelMetadataClass

struct KkcLanguageModelMetadataClass {
	KkcMetadataFileClass parent_class;
};

The class structure for KKC_TYPE_LANGUAGE_MODEL_METADATA. All the fields in this structure are private and should never be accessed directly.

Members

KKC_TYPE_LANGUAGE_MODEL

#define KKC_TYPE_LANGUAGE_MODEL (kkc_language_model_get_type ())

The type for KkcLanguageModel.

struct KkcLanguageModel

struct KkcLanguageModel;

struct KkcLanguageModelClass

struct KkcLanguageModelClass {
	GObjectClass parent_class;
	GeeCollection* (*unigram_entries) (KkcLanguageModel* self, const gchar* input);
	GeeCollection* (*entries) (KkcLanguageModel* self, const gchar* input);
	KkcLanguageModelEntry* (*get) (KkcLanguageModel* self, const gchar* input, const gchar* output);
	gboolean (*parse) (KkcLanguageModel* self, GError** error);
	void (*get_bos) (KkcLanguageModel* self, KkcLanguageModelEntry * result);
	void (*get_eos) (KkcLanguageModel* self, KkcLanguageModelEntry * result);
};

The class structure for KKC_TYPE_LANGUAGE_MODEL. All the fields in this structure are private and should never be accessed directly.

Members

unigram_entries ()

virtual method called by kkc_language_model_unigram_entries()

  

entries ()

virtual method called by kkc_language_model_entries()

  

get ()

    

parse ()

virtual method called by kkc_language_model_parse()

  

get_bos ()

getter method for the abstract property "bos"

  

get_eos ()

getter method for the abstract property "eos"

  

enum KkcLanguageModelError

Members

KKC_LANGUAGE_MODEL_ERROR_NOT_FOUND

    

struct KkcLanguageModelEntry

struct KkcLanguageModelEntry {
	gchar* input;
	gchar* output;
	guint id;
};

KkcUnigramLanguageModel

typedef struct _KkcUnigramLanguageModel KkcUnigramLanguageModel;

struct KkcUnigramLanguageModelIface

struct KkcUnigramLanguageModelIface {
	GTypeInterface parent_iface;
	gdouble (*unigram_cost) (KkcUnigramLanguageModel* self, KkcLanguageModelEntry* entry);
	gdouble (*unigram_backoff) (KkcUnigramLanguageModel* self, KkcLanguageModelEntry* entry);
};

Interface for creating KkcUnigramLanguageModel implementations.

Members

GTypeInterface parent_iface;

the parent interface structure

  

unigram_cost ()

virtual method called by kkc_unigram_language_model_unigram_cost()

  

unigram_backoff ()

virtual method called by kkc_unigram_language_model_unigram_backoff()

  

KkcBigramLanguageModel

typedef struct _KkcBigramLanguageModel KkcBigramLanguageModel;

struct KkcBigramLanguageModelIface

struct KkcBigramLanguageModelIface {
	GTypeInterface parent_iface;
	gboolean (*has_bigram) (KkcBigramLanguageModel* self, KkcLanguageModelEntry* pentry, KkcLanguageModelEntry* entry);
	gdouble (*bigram_cost) (KkcBigramLanguageModel* self, KkcLanguageModelEntry* pentry, KkcLanguageModelEntry* entry);
	gdouble (*bigram_backoff) (KkcBigramLanguageModel* self, KkcLanguageModelEntry* pentry, KkcLanguageModelEntry* entry);
};

Interface for creating KkcBigramLanguageModel implementations.

Members

GTypeInterface parent_iface;

the parent interface structure

  

has_bigram ()

virtual method called by kkc_bigram_language_model_has_bigram()

  

bigram_cost ()

virtual method called by kkc_bigram_language_model_bigram_cost()

  

bigram_backoff ()

virtual method called by kkc_bigram_language_model_bigram_backoff()

  

KkcTrigramLanguageModel

typedef struct _KkcTrigramLanguageModel KkcTrigramLanguageModel;

struct KkcTrigramLanguageModelIface

struct KkcTrigramLanguageModelIface {
	GTypeInterface parent_iface;
	gboolean (*has_trigram) (KkcTrigramLanguageModel* self, KkcLanguageModelEntry* ppentry, KkcLanguageModelEntry* pentry, KkcLanguageModelEntry* entry);
	gdouble (*trigram_cost) (KkcTrigramLanguageModel* self, KkcLanguageModelEntry* ppentry, KkcLanguageModelEntry* pentry, KkcLanguageModelEntry* entry);
};

Interface for creating KkcTrigramLanguageModel implementations.

Members

GTypeInterface parent_iface;

the parent interface structure

  

has_trigram ()

virtual method called by kkc_trigram_language_model_has_trigram()

  

trigram_cost ()

virtual method called by kkc_trigram_language_model_trigram_cost()

  

Property Details

The “model-type” property

  “model-type”               GType *

model-type.

Flags: Read / Write / Construct

Allowed values: void

The “bos” property

  “bos”                      KkcLanguageModelEntry *

bos.

Flags: Read

The “eos” property

  “eos”                      KkcLanguageModelEntry *

eos.

Flags: Read

The “metadata” property

  “metadata”                 KkcLanguageModelMetadata *

metadata.

Flags: Read / Write / Construct

Generated by GTK-Doc V1.28