overview of functions provided

// namespaces

namespace conf;

// typedefs

typedef float spc_;
typedef double rpc_;
typedef int ipc_;

// structs

struct roots_control_type;
struct roots_inform_type;

// global functions

void roots_initialize(
    void **data,
    struct roots_control_type* control,
    ipc_ *status
);

void roots_information(
    void **data,
    struct roots_inform_type* inform,
    ipc_ *status
);

void roots_terminate(
    void **data,
    struct roots_control_type* control,
    struct roots_inform_type* inform
);

typedefs

typedef float spc_

spc_ is real single precision

typedef double rpc_

rpc_ is the real working precision used, but may be changed to float by defining the preprocessor variable SINGLE.

typedef int ipc_

ipc_ is the default integer word length used, but may be changed to int64_t by defining the preprocessor variable INTEGER_64.

function calls

void roots_initialize(
    void **data,
    struct roots_control_type* control,
    ipc_ *status
)

Set default control values and initialize private data

Parameters:

data	holds private internal data
control	is a struct containing control information (see roots_control_type)
status	is a scalar variable of type ipc_, that gives the exit status from the package. Possible values are (currently): 0 The initialization was successful.

void roots_information(
    void **data,
    struct roots_inform_type* inform,
    ipc_ *status
)

Provides output information

Parameters:

data	holds private internal data
inform	is a struct containing output information (see roots_inform_type)
status	is a scalar variable of type ipc_, that gives the exit status from the package. Possible values are (currently): 0 The values were recorded successfully

void roots_terminate(
    void **data,
    struct roots_control_type* control,
    struct roots_inform_type* inform
)

Deallocate all internal private storage

Parameters:

data	holds private internal data
control	is a struct containing control information (see roots_control_type)
inform	is a struct containing output information (see roots_inform_type)