sml.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define SML_INTERNAL_ERROR 3 
#define SML_VARIABLE_NAME_MAX_LEN (127) 
struct sml_object;

struct sml_variable;

struct sml_variables_list;

typedef bool (*sml_read_state_cb) (struct sml_object *sml, void *data);

typedef void (*sml_change_cb)(struct sml_object *sml, struct sml_variables_list *changed, void *data);


bool sml_load_fll_file(struct sml_object *sml, const char *filename);

void sml_free(struct sml_object *sml);

bool sml_set_read_state_callback(struct sml_object *sml, sml_read_state_cb read_state_cb, void *data);

bool sml_set_output_state_changed_callback(struct sml_object *sml, sml_change_cb output_state_changed_cb, void *data);


bool sml_set_learn_disabled(struct sml_object *sml, bool disable);

int sml_process(struct sml_object *sml);

bool sml_predict(struct sml_object *sml);

bool sml_set_stabilization_hits(struct sml_object *sml, uint16_t hits);

bool sml_erase_knowledge(struct sml_object *sml);

bool sml_save(struct sml_object *sml, const char *path);

bool sml_load(struct sml_object *sml, const char *path);

void sml_print_debug(struct sml_object *sml, bool full);

bool sml_set_debug_log_file(struct sml_object *sml, const char *str);

bool sml_load_debug_log_file(struct sml_object *sml, const char *str);

bool sml_set_max_memory_for_observations(struct sml_object *sml, unsigned int max_size);

struct sml_variables_list *sml_get_input_list(struct sml_object *sml);

struct sml_variables_list *sml_get_output_list(struct sml_object *sml);

struct sml_variable *sml_new_input(struct sml_object *sml, const char *name);

struct sml_variable *sml_new_output(struct sml_object *sml, const char *name);

struct sml_variable *sml_get_input(struct sml_object *sml, const char *name);

struct sml_variable *sml_get_output(struct sml_object *sml, const char *name);

bool sml_variable_set_value(struct sml_object *sml, struct sml_variable *sml_variable, float value);

float sml_variable_get_value(struct sml_object *sml, struct sml_variable *sml_variable);

int sml_variable_get_name(struct sml_object *sml, struct sml_variable *sml_variable, char *var_name, size_t var_name_size);

int sml_variable_set_enabled(struct sml_object *sml, struct sml_variable *variable, bool enabled);

bool sml_variable_is_enabled(struct sml_object *sml, struct sml_variable *variable);

bool sml_remove_variable(struct sml_object *sml, struct sml_variable *variable);

uint16_t sml_variables_list_get_length(struct sml_object *sml, struct sml_variables_list *list);

struct sml_variable *sml_variables_list_index(struct sml_object *sml, struct sml_variables_list *list, uint16_t index);

bool sml_variables_list_contains(struct sml_object *sml, struct sml_variables_list *list, struct sml_variable *var);

bool sml_variable_set_range(struct sml_object *sml, struct sml_variable *sml_variable, float min, float max);

bool sml_variable_get_range(struct sml_object *sml, struct sml_variable *sml_variable, float *min, float *max);

#define SML_VARIABLES_LIST_FOREACH(sml, list, len, var, i) \
    for (i = 0, len = sml_variables_list_get_length(sml, list); \
        i < len && ((var = sml_variables_list_index(sml, list, i))); \
        i++)

#ifdef __cplusplus
}
#endif