Files
armadillo-code/include/armadillo_bits/upgrade_val.hpp
T
2025-08-08 20:20:21 +10:00

253 lines
7.8 KiB
C++

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2008-2016 Conrad Sanderson (https://conradsanderson.id.au)
// Copyright 2008-2016 National ICT Australia (NICTA)
//
// 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
// https://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.
// ------------------------------------------------------------------------
//! \addtogroup upgrade_val
//! @{
//! upgrade_val is used to ensure an operation such as multiplication is possible between two types.
//! values are upgraded only where necessary.
template<typename T1, typename T2>
struct upgrade_val
{
typedef typename promote_type<T1,T2>::result T1_result;
typedef typename promote_type<T1,T2>::result T2_result;
static
constexpr
typename promote_type<T1,T2>::result
apply(const T1 x)
{
typedef typename promote_type<T1,T2>::result out_type;
return out_type(x);
}
static
constexpr
typename promote_type<T1,T2>::result
apply(const T2 x)
{
typedef typename promote_type<T1,T2>::result out_type;
return out_type(x);
}
};
// template<>
template<typename T>
struct upgrade_val<T,T>
{
typedef T T1_result;
typedef T T2_result;
static constexpr const T& apply(const T& x) { return x; }
};
//! upgrade a type to allow multiplication with a complex type
//! eg. the int in "int * complex<double>" is upgraded to a double
// template<>
template<typename T, typename T2>
struct upgrade_val< std::complex<T>, T2 >
{
typedef std::complex<T> T1_result;
typedef T T2_result;
static constexpr const std::complex<T>& apply(const std::complex<T>& x) { return x; }
static constexpr T apply(const T2 x) { return T(x); }
};
// template<>
template<typename T1, typename T>
struct upgrade_val< T1, std::complex<T> >
{
typedef T T1_result;
typedef std::complex<T> T2_result;
static constexpr T apply(const T1 x) { return T(x); }
static constexpr const std::complex<T>& apply(const std::complex<T>& x) { return x; }
};
//! ensure we don't lose precision when multiplying a complex number with a higher precision real number
template<>
struct upgrade_val< std::complex<float>, double >
{
typedef std::complex<double> T1_result;
typedef double T2_result;
static constexpr const std::complex<double> apply(const std::complex<float>& x) { return std::complex<double>(x); }
static constexpr double apply(const double x) { return x; }
};
template<>
struct upgrade_val< double, std::complex<float> >
{
typedef double T1_result;
typedef std::complex<float> T2_result;
static constexpr double apply(const double x) { return x; }
static constexpr const std::complex<double> apply(const std::complex<float>& x) { return std::complex<double>(x); }
};
//! ensure we don't lose precision when multiplying complex numbers with different underlying types
template<>
struct upgrade_val< std::complex<float>, std::complex<double> >
{
typedef std::complex<double> T1_result;
typedef std::complex<double> T2_result;
static constexpr const std::complex<double> apply(const std::complex<float>& x) { return std::complex<double>(x); }
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
};
template<>
struct upgrade_val< std::complex<double>, std::complex<float> >
{
typedef std::complex<double> T1_result;
typedef std::complex<double> T2_result;
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
static constexpr const std::complex<double> apply(const std::complex<float>& x) { return std::complex<double>(x); }
};
template<>
struct upgrade_val< std::complex<double>, float >
{
typedef std::complex<double> T1_result;
typedef double T2_result;
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
static constexpr double apply(const float x) { return double(x); }
};
template<>
struct upgrade_val< float, std::complex<double> >
{
typedef double T1_result;
typedef std::complex<double> T2_result;
static constexpr double apply(const float x) { return double(x); }
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
};
#if defined(ARMA_HAVE_FP16)
template<>
struct upgrade_val< std::complex<fp16>, std::complex<double> >
{
typedef std::complex<double> T1_result;
typedef std::complex<double> T2_result;
static constexpr const std::complex<double> apply(const std::complex<fp16>& x) { return std::complex<double>(x); }
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
};
template<>
struct upgrade_val< std::complex<double>, std::complex<fp16> >
{
typedef std::complex<double> T1_result;
typedef std::complex<double> T2_result;
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
static constexpr const std::complex<double> apply(const std::complex<fp16>& x) { return std::complex<double>(x); }
};
template<>
struct upgrade_val< std::complex<fp16>, std::complex<float> >
{
typedef std::complex<float> T1_result;
typedef std::complex<float> T2_result;
static constexpr const std::complex<float> apply(const std::complex<fp16>& x) { return std::complex<float>(x); }
static constexpr const std::complex<float>& apply(const std::complex<float>& x) { return x; }
};
template<>
struct upgrade_val< std::complex<float>, std::complex<fp16> >
{
typedef std::complex<float> T1_result;
typedef std::complex<float> T2_result;
static constexpr const std::complex<float>& apply(const std::complex<float>& x) { return x; }
static constexpr const std::complex<float> apply(const std::complex<fp16>& x) { return std::complex<float>(x); }
};
template<>
struct upgrade_val< std::complex<double>, fp16 >
{
typedef std::complex<double> T1_result;
typedef double T2_result;
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
static constexpr double apply(const fp16 x) { return double(x); }
};
template<>
struct upgrade_val< fp16, std::complex<double> >
{
typedef double T1_result;
typedef std::complex<double> T2_result;
static constexpr double apply(const fp16 x) { return double(x); }
static constexpr const std::complex<double>& apply(const std::complex<double>& x) { return x; }
};
template<>
struct upgrade_val< std::complex<float>, fp16 >
{
typedef std::complex<float> T1_result;
typedef float T2_result;
static constexpr const std::complex<float>& apply(const std::complex<float>& x) { return x; }
static constexpr float apply(const fp16 x) { return float(x); }
};
template<>
struct upgrade_val< fp16, std::complex<float> >
{
typedef float T1_result;
typedef std::complex<float> T2_result;
static constexpr float apply(const fp16 x) { return float(x); }
static constexpr const std::complex<float>& apply(const std::complex<float>& x) { return x; }
};
#endif
//! @}