core.rst

Base Orbit Class

The base Orbit class

Overview

orbithunter.core

Orbit

Methods

Initialization

Examples of these methods are included in in coreoverview

Orbit.__init__ Orbit.populate Orbit._populate_state Orbit._populate_parameters Orbit._parse_state Orbit._parse_parameters

See Python Docs for the definition of 'special'

Special Methods

Orbit.__add__ Orbit.__radd__ Orbit.__sub__ Orbit.__rsub__ Orbit.__mul__ Orbit.__rmul__ Orbit.__truediv__ Orbit.__floordiv__ Orbit.__pow__ Orbit.__mod__ Orbit.__iadd__ Orbit.__isub__ Orbit.__imul__ Orbit.__ipow__ Orbit.__itruediv__ Orbit.__ifloordiv__ Orbit.__imod__ Orbit.__str__ Orbit.__repr__ Orbit.__getattr__ Orbit.__getitem__

Properties

Orbit.shape Orbit.size Orbit.ndim

State Transformations

Orbit.reflection Orbit.roll Orbit.cell_shift Orbit.to_fundamental_domain Orbit.from_fundamental_domain Orbit.resize Orbit._pad Orbit._truncate

Math Functions

Orbit.orbit_vector Orbit.eqn Orbit.matvec Orbit.rmatvec Orbit.jacobian Orbit.hess Orbit.hessp Orbit.cost Orbit.costgrad Orbit.costhess Orbit.costhessp Orbit.abs Orbit.dot Orbit.norm Orbit.rescale Orbit.from_numpy_array Orbit.increment

Discretization and Dimension

Orbit.shapes Orbit.dimensions Orbit.glue_dimensions Orbit.periodic_dimensions Orbit.dimension_based_discretization

Reading and Writing

Orbit.filename Orbit.to_h5

Static

Orbit.bases_labels Orbit.parameter_labels Orbit.dimension_labels Orbit.discretization_labels Orbit.minimal_shape Orbit.minimal_shape_increments

Other

Orbit.copy Orbit.mask Orbit.constrain Orbit.preprocess

Defaults

Orbit.defaults Orbit._default_shape Orbit._default_parameter_ranges Orbit._default_constraints

Utility Functions

convert_class