localization.h

Go to the documentation of this file.

#ifndef _LOSC_INCLUDE_C_LOSC_LOCALIZATION_H_
#define _LOSC_INCLUDE_C_LOSC_LOCALIZATION_H_

#include <c_losc/matrix.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

//**********************************************
// ==> Interface for `losc::LocalizerBase`
//**********************************************

typedef struct _LocalizerBase _LocalizerBase;

typedef struct LoscLocalizerBase {
    _LocalizerBase *_p_base;

    // List interface of methods exposed to C users bellow.

    void (*set_max_iter)(const LoscLocalizerBase *self, size_t max_iter);

    void (*set_convergence)(const LoscLocalizerBase *self, double tol);

    void (*set_random_permutation)(const LoscLocalizerBase *self, bool flag);

    void (*lo_U)(const LoscLocalizerBase *self, losc_matrix *L, losc_matrix *U);
} LoscLocalizerBase;

//**********************************************
// ==> Interface for `losc::LoscLocalizerV2`
//**********************************************

typedef struct _LoscLocalizerV2 _LoscLocalizerV2;

typedef struct LoscLocalizerV2 {
    _LoscLocalizerV2 *_p_v2;

    LoscLocalizerBase *p_base;

    // @note
    // If `losc::LoscLocalizerV2` has new public functions (new functions added
    // in `losc::LoscLocalizerV2` not in its base class) in the future, add the
    // corresponding C interface with new function pointers below.
} LoscLocalizerV2;

LoscLocalizerV2 *losc_localizer_v2_create(
    const losc_matrix *C_lo_basis, const losc_matrix *H_ao,
    const losc_matrix *D_ao[3]);

#define losc_localizer_v2_free(ptr) _losc_localizer_v2_free(&(ptr))
void *_losc_localizer_v2_free(LoscLocalizerV2 **pptr_self);

#ifdef __cplusplus
}
#endif

#endif