Scalar.h
Go to the documentation of this file.
// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SURGSIM_MATH_SCALAR_H
#define SURGSIM_MATH_SCALAR_H
namespace SurgSim
{
namespace Math
{
template <class T>
T clamp(T value, T min, T max, T epsilon);
template<typename T>
class clampOperator
{
public:
clampOperator(const T& min, const T& max, const T& epsilon) : m_min(min), m_max(max),
m_epsilon(epsilon) {}
const T operator()(const T& x) const;
private:
T m_min;
T m_max;
T m_epsilon;
};
};
};
#include "SurgSim/Math/Scalar-inl.h"
#endif // SURGSIM_MATH_SCALAR_H
SurgSim::Math::clampOperator::m_max
T m_max
The maximum value of the interval.
Definition: Scalar.h:64
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
Scalar-inl.h
SurgSim::Math::clampOperator::m_epsilon
T m_epsilon
The closeness parameter for the clamp.
Definition: Scalar.h:68
SurgSim::Math::clampOperator::clampOperator
clampOperator(const T &min, const T &max, const T &epsilon)
Constructor.
Definition: Scalar.h:51
SurgSim::Math::clamp
T clamp(T value, T min, T max, T epsilon)
Clamp any values within an epsilon window to a maximum or minimum value.
Definition: Scalar-inl.h:27
SurgSim::Math::clampOperator::m_min
T m_min
The minimum value of the interval.
Definition: Scalar.h:61
SurgSim::Math::clampOperator
define a custom template unary functor to execute the clamp operation over an Eigen matrix structure...
Definition: Scalar.h:42
SurgSim::Math::clampOperator::operator()
const T operator()(const T &x) const
Execute the clamp operator.
Definition: Scalar-inl.h:33