FillMillerIndex Class Reference

Create a single-batched "list" of Miller indices. More...

Detailed Description

Create a single-batched "list" of Miller indices.

#include <FillMillerIndex.h>

Inheritance diagram for FillMillerIndex:

Public Member Functions
	FillMillerIndex (const OptionSet &options)
	Construct a new FillMillerIndex object.
Public Member Functions inherited from MillerIndex
Scalar	operator() (Size i) const
	Accessor.
MillerIndex	reduce () const
	Reduce to the greatest common demoninator.
Vec	to_vec (const TensorOptions &options=default_tensor_options()) const
	Convert back to a (real) Vec.
Vec	to_normalized_vec (const TensorOptions &options=default_tensor_options()) const
	Convert back to a normalized real Vec.
Public Member Functions inherited from PrimitiveTensor< MillerIndex, 3 >
	PrimitiveTensor ()=default
	Special member functions.
	PrimitiveTensor (const ATensor &tensor, Size batch_dim)
	Construct from another ATensor given batch dimension.
	PrimitiveTensor (const ATensor &tensor, const TraceableTensorShape &batch_shape)
	Construct from another ATensor given batch shape.
	PrimitiveTensor (const Tensor &tensor)
	Copy constructor.
	PrimitiveTensor (const ATensor &tensor)
	Construct from another ATensor and infer batch dimension.
	operator Tensor () const
	Implicit conversion to a Tensor and loses information on the fixed base shape.
Public Member Functions inherited from TensorBase< MillerIndex >
	TensorBase ()=default
	Special member functions.
	TensorBase (const ATensor &tensor, Size batch_dim)
	Construct from another ATensor with given batch dimension.
	TensorBase (const ATensor &tensor, const TraceableTensorShape &batch_shape)
	Construct from another ATensor with given batch shape.
	TensorBase (const neml2::Tensor &tensor)
	Copy constructor.
	TensorBase (double)=delete
	TensorBase (float)=delete
	TensorBase (int)=delete
MillerIndex	variable_data () const
MillerIndex	clone () const
MillerIndex	detach () const
	Discard function graph.
MillerIndex	to (const TensorOptions &options) const
	Change tensor options.
MillerIndex	operator- () const
	Negation.
bool	batched () const
	Whether the tensor is batched.
Size	batch_dim () const
	Return the number of batch dimensions.
Size	base_dim () const
	Return the number of base dimensions.
const TraceableTensorShape &	batch_sizes () const
	Return the batch size.
TraceableSize	batch_size (Size index) const
	Return the size of a batch axis.
TensorShapeRef	base_sizes () const
	Return the base size.
Size	base_size (Size index) const
	Return the size of a base axis.
Size	base_storage () const
	Return the flattened storage needed just for the base indices.
MillerIndex	batch_index (indexing::TensorIndicesRef indices) const
	Get a tensor by slicing on the batch dimensions.
neml2::Tensor	base_index (indexing::TensorIndicesRef indices) const
	Get a tensor by slicing on the base dimensions.
MillerIndex	batch_slice (Size dim, const indexing::Slice &index) const
	Get a tensor by slicing along a batch dimension.
neml2::Tensor	base_slice (Size dim, const indexing::Slice &index) const
	Get a tensor by slicing along a base dimension.
void	batch_index_put_ (indexing::TensorIndicesRef indices, const ATensor &other)
void	batch_index_put_ (indexing::TensorIndicesRef indices, const CScalar &v)
void	base_index_put_ (indexing::TensorIndicesRef indices, const ATensor &other)
void	base_index_put_ (indexing::TensorIndicesRef indices, const CScalar &v)
MillerIndex	batch_expand (const TraceableTensorShape &batch_shape) const
MillerIndex	batch_expand (const TraceableSize &batch_size, Size dim) const
	Return a new view of the tensor with values broadcast along a given batch dimension.
neml2::Tensor	base_expand (TensorShapeRef base_shape) const
	Return a new view of the tensor with values broadcast along the base dimensions.
neml2::Tensor	base_expand (Size base_size, Size dim) const
	Return a new view of the tensor with values broadcast along a given base dimension.
MillerIndex	batch_expand_as (const neml2::Tensor &other) const
	Expand the batch to have the same shape as another tensor.
neml2::Tensor	base_expand_as (const neml2::Tensor &other) const
	Expand the base to have the same shape as another tensor.
MillerIndex	batch_expand_copy (const TraceableTensorShape &batch_shape) const
	Return a new tensor with values broadcast along the batch dimensions.
neml2::Tensor	base_expand_copy (TensorShapeRef base_shape) const
	Return a new tensor with values broadcast along the base dimensions.
MillerIndex	batch_reshape (const TraceableTensorShape &batch_shape) const
	Reshape batch dimensions.
neml2::Tensor	base_reshape (TensorShapeRef base_shape) const
	Reshape base dimensions.
MillerIndex	batch_unsqueeze (Size d) const
	Unsqueeze a batch dimension.
neml2::Tensor	base_unsqueeze (Size d) const
	Unsqueeze a base dimension.
MillerIndex	batch_transpose (Size d1, Size d2) const
	Transpose two batch dimensions.
neml2::Tensor	base_transpose (Size d1, Size d2) const
	Transpose two base dimensions.
neml2::Tensor	base_flatten () const
	Flatten base dimensions.
Public Member Functions inherited from UserTensorBase
	UserTensorBase (const OptionSet &options)
Public Member Functions inherited from NEML2Object
	NEML2Object ()=delete
	NEML2Object (NEML2Object &&)=delete
	NEML2Object (const NEML2Object &)=delete
NEML2Object &	operator= (NEML2Object &&)=delete
NEML2Object &	operator= (const NEML2Object &)=delete
virtual	~NEML2Object ()=default
	NEML2Object (const OptionSet &options)
	Construct a new NEML2Object object.
const OptionSet &	input_options () const
virtual void	setup ()
	Setup this object.
const std::string &	name () const
	A readonly reference to the object's name.
const std::string &	type () const
	A readonly reference to the object's type.
const std::string &	path () const
	A readonly reference to the object's path.
const std::string &	doc () const
	A readonly reference to the object's docstring.
Factory *	factory () const
	Get the factory that created this object.
const Settings &	settings () const
	Settings.
template<typename T = NEML2Object>
const T *	host () const
	Get a readonly pointer to the host.
template<typename T = NEML2Object>
T *	host ()
	Get a writable pointer to the host.
template<typename T >
const T &	resolve_tensor (const std::string &name)
	Resolve a TensorName to a Tensor.
template<class T >
std::shared_ptr< T >	get_object (const std::string &section, const std::string &name)
template<class T = Solver>
std::shared_ptr< T >	get_solver (const std::string &name)
	Get a solver from the factory.
template<class T = Data>
std::shared_ptr< T >	get_data (const std::string &name)
	Get a data from the factory.
template<class T = Model>
std::shared_ptr< T >	get_model (const std::string &name)
	Get a model from the factory.
template<class T = Driver>
std::shared_ptr< T >	get_driver (const std::string &name)
	Get a driver from the factory.
template<class T = WorkScheduler>
std::shared_ptr< T >	get_scheduler (const std::string &name)
	Get a scheduler from the factory.

Static Public Member Functions
static OptionSet	expected_options ()
Static Public Member Functions inherited from MillerIndex
static MillerIndex	fill (int64_t a, int64_t b, int64_t c, const TensorOptions &options=default_integer_tensor_options())
	Most likely construction method – make from three ints.
Static Public Member Functions inherited from PrimitiveTensor< MillerIndex, 3 >
static MillerIndex	create (const TensorDataContainer &data, const TensorOptions &options=default_tensor_options())
	Arbitrary tensor from a nested container with inferred batch dimension.
static MillerIndex	empty (const TensorOptions &options=default_tensor_options())
	Unbatched empty tensor.
static MillerIndex	empty (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
	Empty tensor given batch shape.
static MillerIndex	zeros (const TensorOptions &options=default_tensor_options())
	Unbatched zero tensor.
static MillerIndex	zeros (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
	Zero tensor given batch shape.
static MillerIndex	ones (const TensorOptions &options=default_tensor_options())
	Unbatched unit tensor.
static MillerIndex	ones (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
	Unit tensor given batch shape.
static MillerIndex	full (const CScalar &init, const TensorOptions &options=default_tensor_options())
	Unbatched tensor filled with a given value given base shape.
static MillerIndex	full (const TraceableTensorShape &batch_shape, const CScalar &init, const TensorOptions &options=default_tensor_options())
	Full tensor given batch shape.
static Tensor	identity_map (const TensorOptions &)
	Derived tensor classes should define identity_map where appropriate.
Static Public Member Functions inherited from TensorBase< MillerIndex >
static MillerIndex	empty_like (const MillerIndex &other)
static MillerIndex	zeros_like (const MillerIndex &other)
	Zero tensor like another, i.e. same batch and base shapes, same tensor options, etc.
static MillerIndex	ones_like (const MillerIndex &other)
	Unit tensor like another, i.e. same batch and base shapes, same tensor options, etc.
static MillerIndex	full_like (const MillerIndex &other, const CScalar &init)
static MillerIndex	linspace (const MillerIndex &start, const MillerIndex &end, Size nstep, Size dim=0)
	Create a new tensor by adding a new batch dimension with linear spacing between start and end.
static MillerIndex	logspace (const MillerIndex &start, const MillerIndex &end, Size nstep, Size dim=0, const CScalar &base=10)
	log-space equivalent of the linspace named constructor
Static Public Member Functions inherited from UserTensorBase
static OptionSet	expected_options ()
Static Public Member Functions inherited from NEML2Object
static OptionSet	expected_options ()

Additional Inherited Members
Static Public Attributes inherited from PrimitiveTensor< MillerIndex, 3 >
static const TensorShape	const_base_sizes
	The base shape.
static constexpr Size	const_base_dim
	The base dim.
static const Size	const_base_storage
	The base storage.
Protected Attributes inherited from TensorBase< MillerIndex >
TraceableTensorShape	_batch_sizes
	Traceable batch sizes.

Constructor & Destructor Documentation

FillMillerIndex()

FillMillerIndex

(

const OptionSet &

options

)

Construct a new FillMillerIndex object.

Parameters

options

The options extracted from the input file.

Member Function Documentation

expected_options()

OptionSet expected_options ( )

static