interp_method_dnn.h

Go to the documentation of this file.

// Copyright (c) 2026 The YAC Authors
//
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef INTERP_METHOD_DNN_H
#define INTERP_METHOD_DNN_H
 
#include "interpolation/methods/interp_method.h"
 
// YAC PUBLIC HEADER START
 
enum yac_interp_dnn_weight_type {
  YAC_INTERP_DNN_WEIGHT_AVG   = 0, 
  YAC_INTERP_DNN_WEIGHT_DIST  = 1, 
  YAC_INTERP_DNN_WEIGHT_GAUSS = 2, 
  YAC_INTERP_DNN_WEIGHT_RBF   = 3, 
};
 
enum yac_interp_dnn_search_distance_type {
  YAC_INTERP_DNN_SEARCH_DISTANCE_FIXED = 0,
  YAC_INTERP_DNN_SEARCH_DISTANCE_CELL_AREA = 1,
  YAC_INTERP_DNN_SEARCH_DISTANCE_UNDEFINED = 2,
};
 
// Default scaling values to be used if weight type is neither GAUSS nor RBF,
// to avoid uninitialized values in the config struct
#define YAC_INTERP_DNN_DUMMY_SCALE (0.0)
 
// Default scale values for gauss and rbf weight method
#define YAC_INTERP_DNN_GAUSS_SCALE_DEFAULT (0.1)
#define YAC_INTERP_DNN_RBF_SCALE_DEFAULT (1.487973e+01)
 
#define YAC_INTERP_DNN_SEARCH_DISTANCE_FIXED_DEFAULT (0.0)
#define YAC_INTERP_DNN_SEARCH_DISTANCE_CELL_AREA_DEFAULT (1.0)
 
// by default a single source point within the search distance is sufficient
// to interpolate a target point
#define YAC_INTERP_DNN_N_MIN_DEFAULT (1)
 
// Cell area is the default search distance type, because there is no fixed
// search distance that works well for all cases. The cell area-based search distance adapts to
// the local grid resolution.
#define YAC_INTERP_DNN_WEIGHT_DEFAULT (YAC_INTERP_DNN_WEIGHT_DIST)
#define YAC_INTERP_DNN_SEARCH_DISTANCE_TYPE_DEFAULT (YAC_INTERP_DNN_SEARCH_DISTANCE_CELL_AREA)
#define YAC_INTERP_DNN_SEARCH_DISTANCE_DEFAULT (YAC_INTERP_DNN_SEARCH_DISTANCE_CELL_AREA_DEFAULT)
#define YAC_INTERP_DNN_SCALE_DEFAULT (YAC_INTERP_DNN_DUMMY_SCALE)
 
struct yac_interp_method_dnn_config_search_distance {
  enum yac_interp_dnn_search_distance_type type;
  union {
    double fixed;
    double scale;
  } search_distance;
};
 
struct yac_interp_method_dnn_config {
  enum yac_interp_dnn_weight_type type;
  struct yac_interp_method_dnn_config_search_distance * search_distance;
  int n_min;
  double gauss_scale;
  double rbf_scale;
};
 
struct interp_method * yac_interp_method_dnn_new(
  struct yac_interp_method_dnn_config config);
 
// YAC PUBLIC HEADER STOP
 
// Modular config constructor for vtable-based config system
 
struct yac_interp_method_config *yac_interp_method_config_default_dnn_new(void);
 
#endif // INTERP_METHOD_DNN_H