arts_api.cc

Go to the documentation of this file.

#include "arts_api.h"

#include "agenda_class.h"
#include "arts.h"
#include "auto_md.h"
#include "auto_version.h"
#include "global_data.h"
#include "interactive_workspace.h"
#include "parameters.h"
#include "parser.h"
#include "workspace_ng.h"

using global_data::md_data;
using global_data::wsv_group_names;
extern Parameters parameters;
extern Verbosity verbosity_at_launch;
extern String out_basename;
Index get_wsv_id(const char *);

using global_data::MdMap;

std::string string_buffer;

//extern "C" {

// Internal Helper Functions

void copy_output_and_input(ArrayOfIndex &output,
                           ArrayOfIndex &input,
                           unsigned long n_args_out,
                           const long *args_out,
                           unsigned long n_args_in,
                           const long *args_in) {
  output.reserve(n_args_out);
  for (size_t i = 0; i < n_args_out; ++i) {
    output.push_back(args_out[i]);
  }
  input.reserve(n_args_in);
  for (size_t i = 0; i < n_args_in; ++i) {
    input.push_back(args_in[i]);
  }
}

// Setup and Finalization.

void include_path_push(const char *path) {
  parameters.includepath.push_back(path);
}

void include_path_pop() { parameters.includepath.pop_back(); }

void data_path_push(const char *path) { parameters.datapath.push_back(path); }

void data_path_pop() { parameters.datapath.pop_back(); }

void initialize() { InteractiveWorkspace::initialize(); }

void finalize() {
  // Nothing to do here.
}

const char *get_error() { return string_buffer.c_str(); }

void set_basename(const char *name) { out_basename = name; }

// Parsing and executing agendas.
Agenda *parse_agenda(const char *filename) {
  Agenda *a = new Agenda;
  ArtsParser parser = ArtsParser(*a, filename, verbosity_at_launch);

  try {
    parser.parse_tasklist();
    a->set_name(filename);
    a->set_main_agenda();
  } catch (const std::exception &e) {
    string_buffer = std::string(e.what());
    return nullptr;
  }
  return a;
}

Agenda *create_agenda(const char *name) {
  Agenda *ptr = new Agenda;
  ptr->set_name(name);
  return ptr;
}

void agenda_insert_set(InteractiveWorkspace *workspace,
                       Agenda *a,
                       long id,
                       long group_id) {
  TokVal t{};
  ArrayOfIndex output(1), input(0);
  output[0] = id;
  std::stringstream s;
  s << wsv_group_names[group_id] << "Set";
  Index m_id = MdMap.at(String(s.str()));
  MRecord mr;

  // Agenda
  if (wsv_group_names[group_id] == "Agenda") {
    const Agenda &agenda =
        *reinterpret_cast<Agenda *>(workspace->operator[](id));
    mr = MRecord(m_id, output, input, t, agenda);
  } else {
    // Index
    if (wsv_group_names[group_id] == "Index") {
      t = TokVal(*reinterpret_cast<Index *>(workspace->operator[](id)));
    }
    // Numeric
    if (wsv_group_names[group_id] == "Numeric") {
      t = TokVal(*reinterpret_cast<Numeric *>(workspace->operator[](id)));
    }
    // ArrayOfIndex
    if (wsv_group_names[group_id] == "ArrayOfIndex") {
      t = TokVal(*reinterpret_cast<ArrayOfIndex *>(workspace->operator[](id)));
    }
    // String
    if (wsv_group_names[group_id] == "String") {
      t = TokVal(*reinterpret_cast<String *>(workspace->operator[](id)));
    }
    // ArrayOfString
    if (wsv_group_names[group_id] == "ArrayOfString") {
      t = TokVal(*reinterpret_cast<ArrayOfString *>(workspace->operator[](id)));
    }
    // ArrayOfIndex
    if (wsv_group_names[group_id] == "ArrayOfIndex") {
      t = TokVal(*reinterpret_cast<ArrayOfIndex *>(workspace->operator[](id)));
    }
    // Vector
    if (wsv_group_names[group_id] == "Vector") {
      t = TokVal(*reinterpret_cast<Vector *>(workspace->operator[](id)));
    }
    // Matrix
    if (wsv_group_names[group_id] == "Matrix") {
      t = TokVal(*reinterpret_cast<Matrix *>(workspace->operator[](id)));
    }
    mr = MRecord(m_id, output, input, t, Agenda{});
  }
  a->push_back(mr);
}

void agenda_insert_callback(Agenda *a, void (*f)(InteractiveWorkspace *)) {
  ArrayOfIndex output(0), input(0);
  Index id = md_data.size() - 1;
  Callback *pc = new Callback(f);
  Index callback_id = InteractiveWorkspace::add_callback(pc);
  a->push_back(MRecord(id, output, input, TokVal(callback_id), Agenda{}));
}

void agenda_add_method(Agenda *a,
                       const long id,
                       unsigned long n_output_args,
                       const long *output_args,
                       unsigned long n_input_args,
                       const long *input_args) {
  ArrayOfIndex output, input;
  TokVal t{};
  copy_output_and_input(
      output, input, n_output_args, output_args, n_input_args, input_args);
  MRecord mr(id, output, input, t, Agenda{});
  a->push_back(mr);
}

void agenda_append(Agenda *dst, const Agenda *src) {
  auto methods = src->Methods();
  for (auto m : methods) {
    dst->push_back(m);
  }
}

void agenda_clear(Agenda *a) { a->operator=(Agenda()); }

const char *execute_agenda(InteractiveWorkspace *workspace, const Agenda *a) {
  Agenda b(*a);
  b.set_main_agenda();
  return workspace->execute_agenda(&b);
}

void destroy_agenda(Agenda *a) { delete a; }

// Creating Workspaces
InteractiveWorkspace *create_workspace(const Index verbosity,
                                       const Index agenda_verbosity) {
  return new InteractiveWorkspace(verbosity, agenda_verbosity);
}

void destroy_workspace(InteractiveWorkspace *workspace) { delete workspace; }

// Accessing WSV Group Information

unsigned long get_number_of_groups() { return wsv_group_names.size(); }

const char *get_group_name(int i) { return wsv_group_names[i].c_str(); }

// Accessing and Executing WSMs
unsigned long get_number_of_methods() { return md_data.size(); }

MethodStruct get_method(Index i) {
  MethodStruct m{i,
                 md_data[i].Name().c_str(),
                 md_data[i].Description().c_str(),
                 // Output
                 md_data[i].Out().size(),
                 nullptr,
                 // Generic Output
                 md_data[i].GOut().size(),
                 nullptr,
                 // Input
                 md_data[i].In().size(),
                 nullptr,
                 // Generic Input
                 md_data[i].GIn().size(),
                 nullptr};
  if (m.n_out > 0) {
    m.out = &md_data[i].Out()[0];
  }
  if (m.n_g_in > 0) {
    m.g_in_types = &md_data[i].GInType()[0];
  }
  if (m.n_in > 0) {
    m.in = &md_data[i].In()[0];
  }
  if (m.n_g_out > 0) {
    m.g_out_types = &md_data[i].GOutType()[0];
  }
  return m;
}

const char *get_method_in(Index i, Index j) {
  return md_data[i].GIn()[j].c_str();
}

const char *get_method_g_in(Index i, Index j) {
  return md_data[i].GIn()[j].c_str();
}

const char *get_method_g_in_default(Index i, Index j) {
  return md_data[i].GInDefault()[j].c_str();
}

const char *get_method_out(Index i, Index j) {
  return md_data[i].GIn()[j].c_str();
}

const char *get_method_g_out(Index i, Index j) {
  return md_data[i].GOut()[j].c_str();
}

const char *execute_workspace_method(InteractiveWorkspace *workspace,
                                     long id,
                                     unsigned long n_args_out,
                                     const long *args_out,
                                     unsigned long n_args_in,
                                     const long *args_in) {
  ArrayOfIndex output, input;
  copy_output_and_input(
      output, input, n_args_out, args_out, n_args_in, args_in);
  return workspace->execute_workspace_method(id, output, input);
}

const char *method_print_doc(long id) {
  std::stringstream ss;
  ;
  ss << md_data[id];
  string_buffer = ss.str();
  return string_buffer.c_str();
}

// Accessing and Manipulating WSVs
long lookup_workspace_variable(const char *s) {
  auto it = Workspace::WsvMap.find(s);
  if (it == Workspace::WsvMap.end()) {
    return -1;
  }
  return it->second;
}

unsigned long get_number_of_variables() { return Workspace::wsv_data.size(); }

VariableStruct get_variable(Index i) {
  const WsvRecord &r = Workspace::wsv_data[i];
  return VariableStruct{r.Name().c_str(), r.Description().c_str(), r.Group()};
}

VariableValueStruct get_variable_value(InteractiveWorkspace *workspace,
                                       Index id,
                                       Index group_id) {
  VariableValueStruct value{nullptr,
                            workspace->is_initialized(id),
                            {0, 0, 0, 0, 0, 0},
                            nullptr,
                            nullptr};
  // Index
  if (wsv_group_names[group_id] == "Index") {
    if (value.initialized) {
      value.ptr = workspace->operator[](id);
    }
  }
  // ArrayOfIndex
  else if (wsv_group_names[group_id] == "ArrayOfIndex") {
    if (value.initialized) {
      ArrayOfIndex *a =
          reinterpret_cast<ArrayOfIndex *>(workspace->operator[](id));
      value.dimensions[0] = a->size();
      value.ptr = a->data();
    }
  }
  // String
  else if (wsv_group_names[group_id] == "String") {
    if (value.initialized) {
      value.ptr =
          reinterpret_cast<String *>(workspace->operator[](id))->c_str();
    }
  }
  // Numeric
  else if (wsv_group_names[group_id] == "Numeric") {
    if (value.initialized) {
      value.ptr = reinterpret_cast<Numeric *>(workspace->operator[](id));
    }
  }
  // Vector
  else if (wsv_group_names[group_id] == "Vector") {
    if (value.initialized) {
      Vector *v = reinterpret_cast<Vector *>(workspace->operator[](id));
      value.dimensions[0] = v->nelem();
      if (!v->empty()) {
        value.ptr = v->get_c_array();
      }
    }
  }
  // Matrix
  else if (wsv_group_names[group_id] == "Matrix") {
    if (value.initialized) {
      Matrix *m = reinterpret_cast<Matrix *>(workspace->operator[](id));
      value.dimensions[0] = m->nrows();
      value.dimensions[1] = m->ncols();
      if (!m->empty()) {
        value.ptr = m->get_c_array();
      }
    }
  }
  // Tensor3
  else if (wsv_group_names[group_id] == "Tensor3") {
    if (value.initialized) {
      Tensor3 *t = reinterpret_cast<Tensor3 *>(workspace->operator[](id));
      value.dimensions[0] = t->npages();
      value.dimensions[1] = t->nrows();
      value.dimensions[2] = t->ncols();
      if (!t->empty()) {
        value.ptr = t->get_c_array();
      }
    }
  }
  // Tensor4
  else if (wsv_group_names[group_id] == "Tensor4") {
    if (value.initialized) {
      Tensor4 *t = reinterpret_cast<Tensor4 *>(workspace->operator[](id));
      value.dimensions[0] = t->nbooks();
      value.dimensions[1] = t->npages();
      value.dimensions[2] = t->nrows();
      value.dimensions[3] = t->ncols();
      if (!t->empty()) {
        value.ptr = t->get_c_array();
      }
    }
  }
  // Tensor5
  else if (wsv_group_names[group_id] == "Tensor5") {
    if (value.initialized) {
      Tensor5 *t = reinterpret_cast<Tensor5 *>(workspace->operator[](id));
      value.dimensions[0] = t->nshelves();
      value.dimensions[1] = t->nbooks();
      value.dimensions[2] = t->npages();
      value.dimensions[3] = t->nrows();
      value.dimensions[4] = t->ncols();
      if (!t->empty()) {
        value.ptr = t->get_c_array();
      }
    }
  }
  // Tensor6
  else if (wsv_group_names[group_id] == "Tensor6") {
    if (value.initialized) {
      Tensor6 *t = reinterpret_cast<Tensor6 *>(workspace->operator[](id));
      value.dimensions[0] = t->nvitrines();
      value.dimensions[1] = t->nshelves();
      value.dimensions[2] = t->nbooks();
      value.dimensions[3] = t->npages();
      value.dimensions[4] = t->nrows();
      value.dimensions[5] = t->ncols();

      if (!t->empty()) {
        value.ptr = t->get_c_array();
      }
    }
  }
  // Tensor7
  else if (wsv_group_names[group_id] == "Tensor7") {
    if (value.initialized) {
      Tensor7 *t = reinterpret_cast<Tensor7 *>(workspace->operator[](id));
      value.dimensions[0] = t->nlibraries();
      value.dimensions[1] = t->nvitrines();
      value.dimensions[2] = t->nshelves();
      value.dimensions[3] = t->nbooks();
      value.dimensions[4] = t->npages();
      value.dimensions[5] = t->nrows();
      value.dimensions[6] = t->ncols();

      if (!t->empty()) {
        value.ptr = t->get_c_array();
      }
    }
  }
  // Sparse
  else if (wsv_group_names[group_id] == "Sparse") {
    if (value.initialized) {
      Sparse *s = reinterpret_cast<Sparse *>(workspace->operator[](id));
      value.dimensions[0] = s->nrows();
      value.dimensions[1] = s->ncols();
      value.dimensions[2] = s->nnz();
      value.ptr = s->get_element_pointer();
      value.inner_ptr = s->get_column_index_pointer();
      value.outer_ptr = s->get_row_start_pointer();
    }
  }
  // Covariance Matrix
  else if (wsv_group_names[group_id] == "CovarianceMatrix") {
    if (value.initialized) {
      CovarianceMatrix *c =
          reinterpret_cast<CovarianceMatrix *>(workspace->operator[](id));

      auto &blocks = c->get_blocks();
      auto &inv_blocks = c->get_inverse_blocks();

      value.ptr = c;
      value.dimensions[0] = blocks.size();
      value.dimensions[1] = inv_blocks.size();
      value.inner_ptr = reinterpret_cast<int *>(blocks.data());
    }
  } else {
    if (value.initialized) {
      value.ptr = workspace->operator[](id);
    }
  }
  return value;
}

void *get_variable_data_pointer(InteractiveWorkspace *workspace, Index id) {
  return workspace->operator[](id);
}

CovarianceMatrixBlockStruct get_covariance_matrix_block(CovarianceMatrix *m,
                                                        long block_index,
                                                        bool inverse) {
  std::vector<Block> &blocks =
      inverse ? m->get_inverse_blocks() : m->get_blocks();

  if ((block_index < 0) || ((size_t)block_index >= blocks.size())) {
    throw std::runtime_error("The block index is invalid.");
  }
  Block &block = blocks[block_index];

  Index i, j;
  std::tie(i, j) = block.get_indices();
  Range rr = block.get_row_range();
  Range cr = block.get_column_range();

  void *ptr = nullptr;
  int *inner_ptr = nullptr;
  int *outer_ptr = nullptr;
  long nnz = 0;

  if (block.get_matrix_type() == Block::MatrixType::dense) {
    ptr = block.get_dense().get_c_array();
  } else {
    Sparse &s = block.get_sparse();
    ptr = s.get_element_pointer();
    inner_ptr = s.get_column_index_pointer();
    outer_ptr = s.get_row_start_pointer();
    nnz = s.nnz();
  }

  CovarianceMatrixBlockStruct b{};
  b.indices[0] = i;
  b.indices[1] = j;
  b.dimensions[0] = rr.get_extent();
  b.dimensions[1] = cr.get_extent();
  b.position[0] = rr.get_start();
  b.position[1] = cr.get_start();
  b.ptr = ptr;
  b.nnz = nnz;
  b.inner_ptr = inner_ptr;
  b.outer_ptr = outer_ptr;
  return b;
}

const char *set_variable_value(InteractiveWorkspace *workspace,
                               long id,
                               long group_id,
                               VariableValueStruct value) {
  // If ptr is null empty variable
  if (value.ptr == nullptr) {
    workspace->initialize_variable(id);
  }
  // Agenda
  else if (wsv_group_names[group_id] == "Agenda") {
    try {
      const Agenda *ptr = reinterpret_cast<const Agenda *>(value.ptr);
      workspace->set_agenda_variable(id, *ptr);
    } catch (const std::exception &e) {
      string_buffer = std::string(e.what());
      return string_buffer.c_str();
    }
  }
  // Index
  else if (wsv_group_names[group_id] == "Index") {
    const Index *ptr = reinterpret_cast<const Index *>(value.ptr);
    workspace->set_index_variable(id, *ptr);
  }
  // Numeric
  else if (wsv_group_names[group_id] == "Numeric") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_numeric_variable(id, *ptr);
  }
  // String
  else if (wsv_group_names[group_id] == "String") {
    const char *ptr = reinterpret_cast<const char *>(value.ptr);
    workspace->set_string_variable(id, ptr);
  }
  // Array of String
  else if (wsv_group_names[group_id] == "ArrayOfString") {
    const char *const *ptr = reinterpret_cast<const char *const *>(value.ptr);
    workspace->set_array_of_string_variable(id, value.dimensions[0], ptr);
  }
  // Array of Index
  else if (wsv_group_names[group_id] == "ArrayOfIndex") {
    const Index *ptr = reinterpret_cast<const Index *>(value.ptr);
    workspace->set_array_of_index_variable(id, value.dimensions[0], ptr);
  }
  // Vector
  else if (wsv_group_names[group_id] == "Vector") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_vector_variable(id, value.dimensions[0], ptr);
  }
  // Matrix
  else if (wsv_group_names[group_id] == "Matrix") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_matrix_variable(
        id, value.dimensions[0], value.dimensions[1], ptr);
  }
  // Tensor3
  else if (wsv_group_names[group_id] == "Tensor3") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_tensor3_variable(
        id, value.dimensions[0], value.dimensions[1], value.dimensions[2], ptr);
  }
  // Tensor4
  else if (wsv_group_names[group_id] == "Tensor4") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_tensor4_variable(id,
                                    value.dimensions[0],
                                    value.dimensions[1],
                                    value.dimensions[2],
                                    value.dimensions[3],
                                    ptr);
  }
  // Tensor5
  else if (wsv_group_names[group_id] == "Tensor5") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_tensor5_variable(id,
                                    value.dimensions[0],
                                    value.dimensions[1],
                                    value.dimensions[2],
                                    value.dimensions[3],
                                    value.dimensions[4],
                                    ptr);
  }
  // Tensor6
  else if (wsv_group_names[group_id] == "Tensor6") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_tensor6_variable(id,
                                    value.dimensions[0],
                                    value.dimensions[1],
                                    value.dimensions[2],
                                    value.dimensions[3],
                                    value.dimensions[4],
                                    value.dimensions[5],
                                    ptr);
  }
  // Tensor7
  else if (wsv_group_names[group_id] == "Tensor7") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_tensor7_variable(id,
                                    value.dimensions[0],
                                    value.dimensions[1],
                                    value.dimensions[2],
                                    value.dimensions[3],
                                    value.dimensions[4],
                                    value.dimensions[5],
                                    value.dimensions[6],
                                    ptr);
  }
  // Sparse
  else if (wsv_group_names[group_id] == "Sparse") {
    const Numeric *ptr = reinterpret_cast<const Numeric *>(value.ptr);
    workspace->set_sparse_variable(id,
                                   value.dimensions[0],
                                   value.dimensions[1],
                                   value.dimensions[2],
                                   ptr,
                                   value.inner_ptr,
                                   value.outer_ptr);
  } else {
    string_buffer = std::string(
        "This variable can currently not be set through the C API."
        " Signal your need to ARTS dev mailing list.");
    return string_buffer.c_str();
  }
  return nullptr;
}

long add_variable(InteractiveWorkspace *workspace,
                  long group_id,
                  const char *name) {
  return workspace->add_variable(group_id, name);
}

DLL_PUBLIC
void erase_variable(InteractiveWorkspace *workspace, long id, long group_id) {
  return workspace->erase_variable(id, group_id);
}

DLL_PUBLIC
VersionStruct get_version() {
  VersionStruct version;
  std::string version_string(ARTS_FULL_VERSION);

  version_string = version_string.substr(5, std::string::npos);
  size_t dash_pos = version_string.find('.');
  version.major =
      static_cast<Index>(std::stoi(version_string.substr(0, dash_pos)));

  version_string = version_string.substr(dash_pos + 1, std::string::npos);
  dash_pos = version_string.find('.');
  version.minor =
      static_cast<Index>(std::stoi(version_string.substr(0, dash_pos)));

  version_string = version_string.substr(dash_pos + 1, std::string::npos);
  version.revision = static_cast<Index>(
      std::stoi(version_string.substr(0, std::string::npos)));

  return version;
}
//}