Vec Class Reference

3-vector. More...

Detailed Description

3-vector.

The storage space is (3).

#include <Vec.h>

Inheritance diagram for Vec:

Public Member Functions
	Vec (const Rot &r)
Scalar	dot (const Vec &v) const
	dot product
Vec	cross (const Vec &v) const
	cross product
R2	outer (const Vec &v) const
	outer product
SR2	self_outer () const
	self outer product
Vec	transform (const R2 &op) const override
	apply a transformation operator
Public Member Functions inherited from VecBase< Vec >
Scalar	operator() (Size i) const
	Accessor.
Scalar	norm_sq () const
	Norm squared.
Scalar	norm () const
	Norm.
Vec	rotate (const Rot &r) const
	Rotate using a Rodrigues vector.
Vec	rotate (const R2 &R) const
	Rotate using a rotation matrix.
R2	drotate (const Rot &r) const
	Derivative of the rotated vector w.r.t. the Rodrigues vector.
R3	drotate (const R2 &R) const
	Derivative of the rotated vector w.r.t. the rotation matrix.
Public Member Functions inherited from PrimitiveTensor< Vec, 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< Vec >
	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
Vec	variable_data () const
Vec	clone () const
Vec	detach () const
	Discard function graph.
Vec	to (const TensorOptions &options) const
	Change tensor options.
Vec	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.
Vec	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.
Vec	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)
Vec	batch_expand (const TraceableTensorShape &batch_shape) const
Vec	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.
Vec	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.
Vec	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.
Vec	batch_reshape (const TraceableTensorShape &batch_shape) const
	Reshape batch dimensions.
neml2::Tensor	base_reshape (TensorShapeRef base_shape) const
	Reshape base dimensions.
Vec	batch_unsqueeze (Size d) const
	Unsqueeze a batch dimension.
neml2::Tensor	base_unsqueeze (Size d) const
	Unsqueeze a base dimension.
Vec	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 Transformable< Vec >
	Transformable ()=default
	Transformable (const Transformable &)=default
	Transformable (Transformable &&) noexcept=default
Transformable &	operator= (const Transformable &)=default
Transformable &	operator= (Transformable &&) noexcept=default
virtual	~Transformable ()=default

Static Public Member Functions
static R2	identity_map (const TensorOptions &options=default_tensor_options())
	The derivative of a Vec with respect to itself.
Static Public Member Functions inherited from VecBase< Vec >
static Vec	fill (const CScalar &v1, const CScalar &v2, const CScalar &v3, const TensorOptions &options=default_tensor_options())
static Vec	fill (const Scalar &v1, const Scalar &v2, const Scalar &v3)
static R2	identity_map (const TensorOptions &options=default_tensor_options())
	The derivative of a vector with respect to itself.
Static Public Member Functions inherited from PrimitiveTensor< Vec, 3 >
static Vec	create (const TensorDataContainer &data, const TensorOptions &options=default_tensor_options())
	Arbitrary tensor from a nested container with inferred batch dimension.
static Vec	empty (const TensorOptions &options=default_tensor_options())
	Unbatched empty tensor.
static Vec	empty (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
	Empty tensor given batch shape.
static Vec	zeros (const TensorOptions &options=default_tensor_options())
	Unbatched zero tensor.
static Vec	zeros (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
	Zero tensor given batch shape.
static Vec	ones (const TensorOptions &options=default_tensor_options())
	Unbatched unit tensor.
static Vec	ones (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
	Unit tensor given batch shape.
static Vec	full (const CScalar &init, const TensorOptions &options=default_tensor_options())
	Unbatched tensor filled with a given value given base shape.
static Vec	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< Vec >
static Vec	empty_like (const Vec &other)
static Vec	zeros_like (const Vec &other)
	Zero tensor like another, i.e. same batch and base shapes, same tensor options, etc.
static Vec	ones_like (const Vec &other)
	Unit tensor like another, i.e. same batch and base shapes, same tensor options, etc.
static Vec	full_like (const Vec &other, const CScalar &init)
static Vec	linspace (const Vec &start, const Vec &end, Size nstep, Size dim=0)
	Create a new tensor by adding a new batch dimension with linear spacing between start and end.
static Vec	logspace (const Vec &start, const Vec &end, Size nstep, Size dim=0, const CScalar &base=10)
	log-space equivalent of the linspace named constructor

Additional Inherited Members
Static Public Attributes inherited from PrimitiveTensor< Vec, 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< Vec >
TraceableTensorShape	_batch_sizes
	Traceable batch sizes.

Constructor & Destructor Documentation

Vec()

Vec

(

const Rot &

r

)

Member Function Documentation

cross()

Vec cross

(

const Vec &

v

)

const

cross product

dot()

Scalar dot

(

const Vec &

v

)

const

dot product

identity_map()

R2 identity_map ( const TensorOptions & options = default_tensor_options() )

staticnodiscard

The derivative of a Vec with respect to itself.

outer()

R2 outer

(

const Vec &

v

)

const

outer product

self_outer()

SR2 self_outer

(

)

const

self outer product

transform()

Vec transform ( const R2 & op ) const

overridevirtual

apply a transformation operator

Parameters

op	the transformation operator

Returns

an instance of the Derived type that has been transform

Implements Transformable< Vec >.