qmckl/src/qmckl.org

QMCkl C header

• Constants
  • Success/failure
  • Precision-related constants
• Header files
• End of header

This file produces the qmckl.h header file, which is included in all other C header files. It is the main entry point to the library.

#ifndef QMCKL_H
#define QMCKL_H

Constants

Success/failure

These are the codes returned by the functions to indicate success or failure. All such functions should have as a return type qmckl_exit_code.

#define QMCKL_SUCCESS 0
#define QMCKL_FAILURE 1

typedef int qmckl_exit_code;

Precision-related constants

Controlling numerical precision enables optimizations. Here, the default parameters determining the target numerical precision and range are defined.

#define QMCKL_DEFAULT_PRECISION 53
#define QMCKL_DEFAULT_RANGE     11

Header files

All the functions expoed in the API are defined in the following header files.

#include <stdlib.h>
#include "qmckl_memory.h"
#include "qmckl_context.h"

End of header

#endif