graph_framework-docs/graph__c__binding_8h_source.html

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------


#ifndef graph_c_binding_h

#define graph_c_binding_h


#include <stddef.h>

#include <stdint.h>

#include <stdbool.h>


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

#ifdef USE_METAL

#define START_GPU @autoreleasepool {

#define END_GPU }

#else

#define START_GPU

#define END_GPU

#endif


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

#ifdef __cplusplus

extern "C" {

#define STRUCT_TAG

#else

#define STRUCT_TAG struct

#endif

    typedef void * graph_node;


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------


    enum graph_type {

        FLOAT,

        DOUBLE,

        COMPLEX_FLOAT,

        COMPLEX_DOUBLE

    };


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------


    struct graph_c_context {

        enum graph_type type;

        bool safe_math;

    };


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    STRUCT_TAG graph_c_context *graph_construct_context(const enum graph_type type,

                                                        const bool use_safe_math);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_destroy_context(STRUCT_TAG graph_c_context *c);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_variable(STRUCT_TAG graph_c_context *c,

                              const size_t size,

                              const char *symbol);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_constant(STRUCT_TAG graph_c_context *c,

                              const double value);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_set_variable(STRUCT_TAG graph_c_context *c,

                            graph_node var,

                            const void *source);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_constant_c(STRUCT_TAG graph_c_context *c,

                                const double real_value,

                                const double img_value);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_pseudo_variable(STRUCT_TAG graph_c_context *c,

                                     graph_node var);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_remove_pseudo(STRUCT_TAG graph_c_context *c,

                                   graph_node var);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_add(STRUCT_TAG graph_c_context *c,

                         graph_node left,

                         graph_node right);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_sub(STRUCT_TAG graph_c_context *c,

                         graph_node left,

                         graph_node right);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_mul(STRUCT_TAG graph_c_context *c,

                         graph_node left,

                         graph_node right);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_div(STRUCT_TAG graph_c_context *c,

                         graph_node left,

                         graph_node right);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_sqrt(STRUCT_TAG graph_c_context *c,

                          graph_node arg);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_exp(STRUCT_TAG graph_c_context *c,

                         graph_node arg);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_log(STRUCT_TAG graph_c_context *c,

                         graph_node arg);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_pow(STRUCT_TAG graph_c_context *c,

                         graph_node left,

                         graph_node right);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_erfi(STRUCT_TAG graph_c_context *c,

                          graph_node arg);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_sin(STRUCT_TAG graph_c_context *c,

                         graph_node arg);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_cos(STRUCT_TAG graph_c_context *c,

                         graph_node arg);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_atan(STRUCT_TAG graph_c_context *c,

                          graph_node left,

                          graph_node right);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_random_state(STRUCT_TAG graph_c_context *c,

                                  const uint32_t seed);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_random(STRUCT_TAG graph_c_context *c,

                            graph_node state);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_piecewise_1D(STRUCT_TAG graph_c_context *c,

                                  graph_node arg,

                                  const double scale,

                                  const double offset,

                                  const void *source,

                                  const size_t source_size);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_piecewise_2D(STRUCT_TAG graph_c_context *c,

                                  const size_t num_cols,

                                  graph_node x_arg,

                                  const double x_scale,

                                  const double x_offset,

                                  graph_node y_arg,

                                  const double y_scale,

                                  const double y_offset,

                                  const void *source,

                                  const size_t source_size);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    size_t graph_get_max_concurrency(STRUCT_TAG graph_c_context *c);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_set_device_number(STRUCT_TAG graph_c_context *c,

                                 const size_t num);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_add_pre_item(STRUCT_TAG graph_c_context *c,

                            graph_node *inputs, size_t num_inputs,

                            graph_node *outputs, size_t num_outputs,

                            graph_node *map_inputs,

                            graph_node *map_outputs, size_t num_maps,

                            graph_node random_state,

                            const char *name,

                            const size_t size);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_add_item(STRUCT_TAG graph_c_context *c,

                        graph_node *inputs, size_t num_inputs,

                        graph_node *outputs, size_t num_outputs,

                        graph_node *map_inputs,

                        graph_node *map_outputs, size_t num_maps,

                        graph_node random_state,

                        const char *name,

                        const size_t size);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_add_converge_item(STRUCT_TAG graph_c_context *c,

                                 graph_node *inputs, size_t num_inputs,

                                 graph_node *outputs, size_t num_outputs,

                                 graph_node *map_inputs,

                                 graph_node *map_outputs, size_t num_maps,

                                 graph_node random_state,

                                 const char *name,

                                 const size_t size,

                                 const double tol,

                                 const size_t max_iter);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_compile(STRUCT_TAG graph_c_context *c);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_pre_run(STRUCT_TAG graph_c_context *c);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_run(STRUCT_TAG graph_c_context *c);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_wait(STRUCT_TAG graph_c_context *c);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_copy_to_device(STRUCT_TAG graph_c_context *c,

                              graph_node node,

                              void *source);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_copy_to_host(STRUCT_TAG graph_c_context *c,

                            graph_node node,

                            void *destination);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    void graph_print(STRUCT_TAG graph_c_context *c,

                     const size_t index,

                     graph_node *nodes,

                     const size_t num_nodes);


//------------------------------------------------------------------------------

//------------------------------------------------------------------------------

    graph_node graph_df(STRUCT_TAG graph_c_context *c,

                        graph_node fnode,

                        graph_node xnode);

#ifdef __cplusplus

}

#endif


#endif /* graph_c_binding_h */

graph_log
graph_node graph_log(STRUCT_TAG graph_c_context *c, graph_node arg)
Create log node.
Definition graph_c_binding.cpp:892

graph_sin
graph_node graph_sin(STRUCT_TAG graph_c_context *c, graph_node arg)
Create sine node.
Definition graph_c_binding.cpp:1068

graph_construct_context
STRUCT_TAG graph_c_context * graph_construct_context(const enum graph_type type, const bool use_safe_math)
Construct a C context.
Definition graph_c_binding.cpp:40

graph_exp
graph_node graph_exp(STRUCT_TAG graph_c_context *c, graph_node arg)
Create exp node.
Definition graph_c_binding.cpp:828

graph_destroy_context
void graph_destroy_context(STRUCT_TAG graph_c_context *c)
Destroy C context.

graph_sqrt
graph_node graph_sqrt(STRUCT_TAG graph_c_context *c, graph_node arg)
Create Sqrt node.
Definition graph_c_binding.cpp:764

graph_constant
graph_node graph_constant(STRUCT_TAG graph_c_context *c, const double value)
Create constant node.
Definition graph_c_binding.cpp:164

graph_pseudo_variable
graph_node graph_pseudo_variable(STRUCT_TAG graph_c_context *c, graph_node var)
Create a pseudo variable.
Definition graph_c_binding.cpp:366

graph_random
graph_node graph_random(STRUCT_TAG graph_c_context *c, graph_node state)
Create random node.
Definition graph_c_binding.cpp:1335

graph_add
graph_node graph_add(STRUCT_TAG graph_c_context *c, graph_node left, graph_node right)
Create Addition node.
Definition graph_c_binding.cpp:498

graph_print
void graph_print(STRUCT_TAG graph_c_context *c, const size_t index, graph_node *nodes, const size_t num_nodes)
Print a value from nodes.
Definition graph_c_binding.cpp:3118

graph_add_item
void graph_add_item(STRUCT_TAG graph_c_context *c, graph_node *inputs, size_t num_inputs, graph_node *outputs, size_t num_outputs, graph_node *map_inputs, graph_node *map_outputs, size_t num_maps, graph_node random_state, const char *name, const size_t size)
Add workflow item.
Definition graph_c_binding.cpp:2127

graph_add_converge_item
void graph_add_converge_item(STRUCT_TAG graph_c_context *c, graph_node *inputs, size_t num_inputs, graph_node *outputs, size_t num_outputs, graph_node *map_inputs, graph_node *map_outputs, size_t num_maps, graph_node random_state, const char *name, const size_t size, const double tol, const size_t max_iter)
Add a converge item.
Definition graph_c_binding.cpp:2467

graph_type
graph_type
Graph base type.
Definition graph_c_binding.h:153

graph_piecewise_1D
graph_node graph_piecewise_1D(STRUCT_TAG graph_c_context *c, graph_node arg, const double scale, const double offset, const void *source, const size_t source_size)
Create 1D piecewise node.
Definition graph_c_binding.cpp:1454

graph_cos
graph_node graph_cos(STRUCT_TAG graph_c_context *c, graph_node arg)
Create cosine node.
Definition graph_c_binding.cpp:1132

graph_mul
graph_node graph_mul(STRUCT_TAG graph_c_context *c, graph_node left, graph_node right)
Create Multiply node.
Definition graph_c_binding.cpp:630

graph_erfi
graph_node graph_erfi(STRUCT_TAG graph_c_context *c, graph_node arg)
Create imaginary error function node.
Definition graph_c_binding.cpp:1022

graph_run
void graph_run(STRUCT_TAG graph_c_context *c)
Run work items.

graph_set_device_number
void graph_set_device_number(STRUCT_TAG graph_c_context *c, const size_t num)
Choose the device number.
Definition graph_c_binding.cpp:1729

graph_pow
graph_node graph_pow(STRUCT_TAG graph_c_context *c, graph_node left, graph_node right)
Create Pow node.
Definition graph_c_binding.cpp:957

graph_variable
graph_node graph_variable(STRUCT_TAG graph_c_context *c, const size_t size, const char *symbol)
Create variable node.
Definition graph_c_binding.cpp:99

graph_get_max_concurrency
size_t graph_get_max_concurrency(STRUCT_TAG graph_c_context *c)
Create 2D piecewise node with complex arguments.

graph_node
void * graph_node
Graph node type for C interface.
Definition graph_c_binding.h:148

graph_df
graph_node graph_df(STRUCT_TAG graph_c_context *c, graph_node fnode, graph_node xnode)
Take derivative ∂f∂x.
Definition graph_c_binding.cpp:3204

graph_sub
graph_node graph_sub(STRUCT_TAG graph_c_context *c, graph_node left, graph_node right)
Create Subtract node.
Definition graph_c_binding.cpp:564

graph_copy_to_host
void graph_copy_to_host(STRUCT_TAG graph_c_context *c, graph_node node, void *destination)
Copy data to a host buffer.
Definition graph_c_binding.cpp:3064

graph_copy_to_device
void graph_copy_to_device(STRUCT_TAG graph_c_context *c, graph_node node, void *source)
Copy data to a device buffer.
Definition graph_c_binding.cpp:3011

graph_atan
graph_node graph_atan(STRUCT_TAG graph_c_context *c, graph_node left, graph_node right)
Create arctangent node.
Definition graph_c_binding.cpp:1197

graph_remove_pseudo
graph_node graph_remove_pseudo(STRUCT_TAG graph_c_context *c, graph_node var)
Remove pseudo.
Definition graph_c_binding.cpp:430

graph_constant_c
graph_node graph_constant_c(STRUCT_TAG graph_c_context *c, const double real_value, const double img_value)
Create complex constant node.
Definition graph_c_binding.cpp:322

graph_div
graph_node graph_div(STRUCT_TAG graph_c_context *c, graph_node left, graph_node right)
Create Divide node.
Definition graph_c_binding.cpp:696

graph_set_variable
void graph_set_variable(STRUCT_TAG graph_c_context *c, graph_node var, const void *source)
Set a variable value.
Definition graph_c_binding.cpp:228

graph_compile
void graph_compile(STRUCT_TAG graph_c_context *c)
Compile the work items.

graph_add_pre_item
void graph_add_pre_item(STRUCT_TAG graph_c_context *c, graph_node *inputs, size_t num_inputs, graph_node *outputs, size_t num_outputs, graph_node *map_inputs, graph_node *map_outputs, size_t num_maps, graph_node random_state, const char *name, const size_t size)
Add pre workflow item.
Definition graph_c_binding.cpp:1789

STRUCT_TAG
#define STRUCT_TAG
Definition graph_c_binding.h:145

graph_random_state
graph_node graph_random_state(STRUCT_TAG graph_c_context *c, const uint32_t seed)
Construct a random state node.
Definition graph_c_binding.cpp:1265

graph_piecewise_2D
graph_node graph_piecewise_2D(STRUCT_TAG graph_c_context *c, const size_t num_cols, graph_node x_arg, const double x_scale, const double x_offset, graph_node y_arg, const double y_scale, const double y_offset, const void *source, const size_t source_size)
Create 2D piecewise node.
Definition graph_c_binding.cpp:1558

graph_wait
void graph_wait(STRUCT_TAG graph_c_context *c)
Wait for work items to complete.

graph_pre_run
void graph_pre_run(STRUCT_TAG graph_c_context *c)
Run pre work items.

graph_c_context
graph_c_context type.
Definition graph_c_binding.h:163

graph_c_context::type
enum graph_type type
Type of the context.
Definition graph_c_binding.h:165

graph_c_context::safe_math
bool safe_math
Uses safe math.
Definition graph_c_binding.h:167