EleFits  5.3.1
A modern C++ API on top of CFITSIO
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Scaling Class Reference

#include <Scaling.h>

Detailed Description

Helper class for scaling parameters.

A scaling can be:

Public Types

enum class  Type {
  Absolute ,
  Factor ,
  Inverse
}
 The type of scaling value. More...
 

Public Member Functions

 Scaling ()
 Default constructor: make identity.
 
 Scaling (double value, Type type=Type::Absolute)
 Constructor.
 
bool is_identity () const
 Check whether the scaling is identity (factor or inverse with value 1).
 
 operator bool () const
 Check whether the scaling is enabled (i.e. the value is not null).
 
bool operator!= (const Scaling &rhs) const
 Check whether two parameters are different.
 
Scaling operator* (double value) const
 New-instance multiplication.
 
Scalingoperator*= (double value)
 Multiply the scaling by a given factor. More...
 
Scaling operator/ (double value)
 New-instance division.
 
Scalingoperator/= (double value)
 Divide the scaling by a given factor. More...
 
bool operator== (const Scaling &rhs) const
 Check whether two parameters are equal.
 
Type type () const
 Get the scaling type.
 
double value () const
 Get the scaling value.
 

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