File: PyFmt2.h

package info (click to toggle)
bornagain 23.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 103,936 kB
  • sloc: cpp: 423,131; python: 40,997; javascript: 11,167; awk: 630; sh: 318; ruby: 173; xml: 130; makefile: 51; ansic: 24
file content (45 lines) | stat: -rw-r--r-- 1,467 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Sim/Export/PyFmt2.h
//! @brief     Defines namespace pyfmt2.
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************

#ifdef SWIG
#error no need to expose this header to Swig
#endif // SWIG
#ifndef BORNAGAIN_SIM_EXPORT_PYFMT2_H
#define BORNAGAIN_SIM_EXPORT_PYFMT2_H

#include <functional>
#include <string>

class IDistribution1D;
class IShape2D;
class ParameterDistribution;
class Scale;

//! Utility functions for writing Python code snippets.

namespace Py::Fmt2 {

std::string representShape2D(const std::string& indent, const IShape2D* ishape, bool mask_value,
                             std::function<std::string(double)> printValueFunc);

std::string printAxis(const Scale* axis, const std::string& unit);

std::string printParameterDistribution(const ParameterDistribution& par_distr,
                                       const std::string& distVarName);

std::string printDistribution(const IDistribution1D& distr);

} // namespace Py::Fmt2

#endif // BORNAGAIN_SIM_EXPORT_PYFMT2_H