GyotoUtils.h

Go to the documentation of this file.

/*
    Copyright 2011, 2016, 2026 Thibaut Paumard

    This file is part of Gyoto.

    Gyoto is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Gyoto 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 Gyoto.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GyotoUtils_H_ 
#define __GyotoUtils_H_ 

#include "GyotoDefs.h"

#include <string>
#include <string_view>
#include <vector>
#include <glob.h>

namespace Gyoto {

  void debug(int mode);
  

  int debug();


  void verbose(int mode);
  

  int verbose();
  

  void convert(double * const x, const std::size_t nelem,
               const double mass_sun, const double distance_kpc,
               const std::string unit);


  bool startsWithCaseInsensitive(std::string_view str, std::string_view prefix);
  

  double stringToDouble(const std::string &str);


  std::string doubleToString(double value);


  void help(std::string class_name);

  std::vector<std::string> split(std::string const &src, std::string const &delim);

  /*
    boost Bessel function as implemented in
    #include <boost/math/special_functions/bessel.hpp> 
    are 50% longer than the following, while the following
    give results accurate at ~1e-6 which is more than enough.
   */
  double bessi0(double xx);
  double bessi1(double xx);
  double bessk0(double xx);
  double bessk1(double xx);
  double bessk(int nn, double xx);

  double hypergeom (double kappaIndex, double thetae); 

  void cartesianToSpherical(double const cpos[3], double spos[3]);
  void sphericalToCartesian(double const spos[3], double cpos[3]);


  // Keep argument names for swig!
  void matrix4Invert(double ARGOUT_ARRAY2[4][4], double const IN_ARRAY2[4][4]);


  // Keep argument names for swig!
  void matrix4CircularInvert(double ARGOUT_ARRAY2[4][4], double const IN_ARRAY2[4][4]);


  std::vector<std::string> glob(const std::string pattern,
                                int flags = GLOB_NOCHECK | GLOB_NOSORT |
                                GLOB_TILDE | GLOB_BRACE);
}

#endif