Eigen  3.4.90 (git rev a4098ac676528a83cfb73d4d26ce1b42ec05f47c)
Eigen::UniformScaling< Scalar_ > Class Template Reference

Detailed Description

template<typename Scalar_>
class Eigen::UniformScaling< Scalar_ >

Represents a generic uniform scaling transformation.

This is defined in the Geometry module.

#include <Eigen/Geometry>
Template Parameters
Scalar_the scalar type, i.e., the type of the coefficients.

This class represent a uniform scaling transformation. It is the return type of Scaling(Scalar), and most of the time this is the only way it is used. In particular, this class is not aimed to be used to store a scaling transformation, but rather to make easier the constructions and updates of Transform objects.

To represent an axis aligned scaling, use the DiagonalMatrix class.

See also
Scaling(), class DiagonalMatrix, MatrixBase::asDiagonal(), class Translation, class Transform

Public Types

typedef Scalar_ Scalar
 

Public Member Functions

template<typename NewScalarType >
UniformScaling< NewScalarType > cast () const
 
UniformScaling inverse () const
 
bool isApprox (const UniformScaling &other, const typename NumTraits< Scalar >::Real &prec=NumTraits< Scalar >::dummy_precision()) const
 
template<typename Derived >
Eigen::internal::plain_matrix_type< Derived >::type operator* (const MatrixBase< Derived > &other) const
 
template<int Dim, int Mode, int Options>
internal::uniformscaling_times_affine_returntype< Scalar, Dim, Mode >::type operator* (const Transform< Scalar, Dim, Mode, Options > &t) const
 
template<int Dim>
Transform< Scalar, Dim, Affineoperator* (const Translation< Scalar, Dim > &t) const
 
UniformScaling operator* (const UniformScaling &other) const
 
 UniformScaling ()
 
 UniformScaling (const Scalar &s)
 
template<typename OtherScalarType >
 UniformScaling (const UniformScaling< OtherScalarType > &other)
 

Related Functions

(Note that these are not member functions.)

template<typename Derived , typename Scalar >
 operator* (const MatrixBase< Derived > &matrix, const UniformScaling< Scalar > &s)
 

Member Typedef Documentation

◆ Scalar

template<typename Scalar_ >
typedef Scalar_ Eigen::UniformScaling< Scalar_ >::Scalar

the scalar type of the coefficients

Constructor & Destructor Documentation

◆ UniformScaling() [1/3]

template<typename Scalar_ >
Eigen::UniformScaling< Scalar_ >::UniformScaling ( )
inline

Default constructor without initialization.

◆ UniformScaling() [2/3]

template<typename Scalar_ >
Eigen::UniformScaling< Scalar_ >::UniformScaling ( const Scalar s)
inlineexplicit

Constructs and initialize a uniform scaling transformation

◆ UniformScaling() [3/3]

template<typename Scalar_ >
template<typename OtherScalarType >
Eigen::UniformScaling< Scalar_ >::UniformScaling ( const UniformScaling< OtherScalarType > &  other)
inlineexplicit

Copy constructor with scalar type conversion

Member Function Documentation

◆ cast()

template<typename Scalar_ >
template<typename NewScalarType >
UniformScaling< NewScalarType > Eigen::UniformScaling< Scalar_ >::cast ( ) const
inline
Returns
*this with scalar type casted to NewScalarType

Note that if NewScalarType is equal to the current scalar type of *this then this function smartly returns a const reference to *this.

◆ inverse()

template<typename Scalar_ >
UniformScaling Eigen::UniformScaling< Scalar_ >::inverse ( ) const
inline
Returns
the inverse scaling

◆ isApprox()

template<typename Scalar_ >
bool Eigen::UniformScaling< Scalar_ >::isApprox ( const UniformScaling< Scalar_ > &  other,
const typename NumTraits< Scalar >::Real &  prec = NumTraits<Scalar>::dummy_precision() 
) const
inline
Returns
true if *this is approximately equal to other, within the precision determined by prec.
See also
MatrixBase::isApprox()

◆ operator*() [1/4]

template<typename Scalar_ >
template<typename Derived >
Eigen::internal::plain_matrix_type< Derived >::type Eigen::UniformScaling< Scalar_ >::operator* ( const MatrixBase< Derived > &  other) const
inline

Concatenates a uniform scaling and a linear transformation matrix

◆ operator*() [2/4]

template<typename Scalar_ >
template<int Dim, int Mode, int Options>
internal::uniformscaling_times_affine_returntype< Scalar, Dim, Mode >::type Eigen::UniformScaling< Scalar_ >::operator* ( const Transform< Scalar, Dim, Mode, Options > &  t) const
inline

Concatenates a uniform scaling and an affine transformation

◆ operator*() [3/4]

template<typename Scalar >
template<int Dim>
Transform< Scalar, Dim, Affine > Eigen::UniformScaling< Scalar >::operator* ( const Translation< Scalar, Dim > &  t) const
inline

Concatenates a uniform scaling and a translation

◆ operator*() [4/4]

template<typename Scalar_ >
UniformScaling Eigen::UniformScaling< Scalar_ >::operator* ( const UniformScaling< Scalar_ > &  other) const
inline

Concatenates two uniform scaling

Friends And Related Function Documentation

◆ operator*()

template<typename Derived , typename Scalar >
operator* ( const MatrixBase< Derived > &  matrix,
const UniformScaling< Scalar > &  s 
)
related

Concatenates a linear transformation matrix and a uniform scaling


The documentation for this class was generated from the following file: