C++ API Documentation

The magpy C++ library powers the core functionality of the python interface. The library doesn’t depend on the python features and is compiled independently of the python code. The C++ API is organised around functions in namespaces and uses classes sparingly. Use the namespace list for browsing the code base.

C++ API

• Namespace list
  • Namespace constants
  • Namespace curry
  • Namespace distances
  • Namespace dom
  • Namespace driver
  • Namespace energy
  • Namespace field
  • Namespace integrator
  • Namespace integrator::ck_butcher_table
  • Namespace io
  • Namespace llg
  • Namespace mnp
  • Namespace moma_config
  • Namespace optimisation
  • Namespace simulation
  • Namespace stochastic
  • Namespace trap
• File list
  • File constants.hpp
  • File curry.hpp
  • File distances.cpp
  • File distances.hpp
  • File dom.cpp
  • File dom.hpp
  • File energy.hpp
  • File field.cpp
  • File field.hpp
  • File integrators.cpp
  • File integrators.hpp
  • File io.hpp
  • File llg.cpp
  • File llg.hpp
  • File mnps.hpp
  • File moma_config.cpp
  • File moma_config.hpp
  • File optimisation.cpp
  • File optimisation.hpp
  • File rng.cpp
  • File rng.hpp
  • File simulation.cpp
  • File simulation.hpp
  • File stochastic_processes.cpp
  • File stochastic_processes.hpp
  • File trap.cpp
  • File trap.hpp
• Class list
  • Class Rng
  • Class RngArray
  • Class RngMtDownsample
  • Class RngMtNorm
• Struct list
  • Struct mnp::norm_params
  • Struct mnp::params
  • Struct simulation::results