Struct Context::Options

Nested Relationships

This struct is a nested type of Class Context.

Struct Documentation

struct Options

helper for the named-parameter constructor of Context

see the Context documentation for detailed description

Public Members

SEQUANT_DESIGNATED_INIT_ONLY
std::shared_ptr<const IndexBasisRegistry> index_basis_registry_shared_ptr = nullptr

a shared_ptr to an IndexBasisRegistry object; the Context adopts it if it is the only owner of the object (e.g. a temporary or a moved-from shared_ptr), else copies the object; see the warning of Context::set(std::shared_ptr<const IndexBasisRegistry>)

std::optional<IndexBasisRegistry> index_basis_registry = std::nullopt

an IndexBasisRegistry object, moved into the Context; used if index_basis_registry_shared_ptr is null and it is nonnull

std::shared_ptr<const IndexBasisRegistry> index_space_registry_shared_ptr = nullptr

Deprecated:

use index_basis_registry_shared_ptr

std::optional<IndexBasisRegistry> index_space_registry = std::nullopt

Deprecated:

use index_basis_registry

Vacuum vacuum = Defaults::vacuum

the Vacuum object

bool assert_strict_braket_symmetry = Defaults::assert_strict_braket_symmetry

the flag that controls the strictness of bra-ket checks in tensor network construction

SPBasis spbasis = Defaults::spbasis

the SPBasis object

std::size_t first_dummy_index_ordinal = Defaults::first_dummy_index_ordinal

the first dummy index ordinal

std::optional<CanonicalizeOptions> canonicalization_options = std::nullopt

the default canonicalization options

BraKetTypesetting braket_typesetting = Defaults::braket_typesetting

the BraKetTypesetting object

BraKetSlotTypesetting braket_slot_typesetting = Defaults::braket_slot_typesetting

the BraKetSlotTypesetting object

Symmetry deserialization_symmetry = Defaults::deserialization_symmetry

the default bra/ket permutational Symmetry for deserialized tensors

Hermiticity deserialization_hermiticity = Defaults::deserialization_hermiticity

the default Hermiticity for deserialized tensors; the braket symmetry of a deserialized tensor is derived from this and its base_field

ColumnSymmetry deserialization_column_symmetry = Defaults::deserialization_column_symmetry

the default ColumnSymmetry (particle-permutation symmetry) for deserialized tensors

std::optional<container::map<std::wstring, std::shared_ptr<TensorCanonicalizer>>> tensor_canonicalizers = std::nullopt

label -> TensorCanonicalizer map, without null entries; the empty label maps to a DefaultTensorCanonicalizer unless given

std::optional<tensor_index_comparer_t> index_comparer = std::nullopt

the Index comparer used by tensor canonicalizers; if not set, TensorCanonicalizer::default_index_comparer()

std::optional<tensor_index_pair_comparer_t> index_pair_comparer = std::nullopt

the Index pair comparer used by tensor canonicalizers; if not set, TensorCanonicalizer::default_index_pair_comparer()

std::optional<container::vector<std::wstring>> cardinal_tensor_labels = std::nullopt

the cardinal Tensor labels; if not set, the reserved labels