fnft_nsep.h

Go to the documentation of this file.

/*
* This file is part of FNFT.
*
* FNFT is free software; you can redistribute it and/or
* modify it under the terms of the version 2 of the GNU General
* Public License as published by the Free Software Foundation.
*
* FNFT is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Contributors:
* Sander Wahls (TU Delft) 2017-2018, 2020.
* Shrinivas Chimmalgi (TU Delft) 2020.
*/
 
#ifndef FNFT_NSEP_H
#define FNFT_NSEP_H
 
#include "fnft__errwarn.h"
#include "fnft__misc.h" // for misc_filter
#include "fnft__poly_roots_fasteigen.h"
#include "fnft__poly_roots_fftgridsearch.h"
#include "fnft__nse_scatter.h"
#include "fnft__nse_fscatter.h"
#include <string.h> // for memcpy
 
typedef enum {
    fnft_nsep_loc_SUBSAMPLE_AND_REFINE,
    fnft_nsep_loc_GRIDSEARCH,
    fnft_nsep_loc_MIXED
} fnft_nsep_loc_t;
 
typedef enum {
    fnft_nsep_filt_NONE,
    fnft_nsep_filt_MANUAL,
    fnft_nsep_filt_AUTO
} fnft_nsep_filt_t;
 
typedef struct {
    fnft_nsep_loc_t localization;
    fnft_nsep_filt_t filtering;
    FNFT_REAL bounding_box[4];
    FNFT_UINT max_evals;
    fnft_nse_discretization_t discretization;
    FNFT_INT normalization_flag;
    FNFT_REAL floquet_range[2];
    FNFT_UINT points_per_spine;
    FNFT_UINT Dsub;
    FNFT_REAL tol;
} fnft_nsep_opts_t;
 
fnft_nsep_opts_t fnft_nsep_default_opts();
 
FNFT_INT fnft_nsep(const FNFT_UINT D, FNFT_COMPLEX const * const q,
    FNFT_REAL const * const T, FNFT_REAL const phase_shift, FNFT_UINT * const K_ptr,
    FNFT_COMPLEX * const main_spec, FNFT_UINT * const M_ptr,
    FNFT_COMPLEX * const aux_spec, FNFT_REAL * const sheet_indices,
    const FNFT_INT kappa, fnft_nsep_opts_t * opts);
 
#endif