/** * @file llunit.h * @brief Unit conversion classes * * $LicenseInfo:firstyear=2001&license=viewerlgpl$ * Second Life Viewer Source Code * Copyright (C) 2012, Linden Research, Inc. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; * version 2.1 of the License only. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA * $/LicenseInfo$ */ #ifndef LL_LLUNIT_H #define LL_LLUNIT_H #include "stdtypes.h" #include "llpreprocessor.h" #include "llerror.h" //lightweight replacement of type traits for simple type equality check template struct LLIsSameType { static const bool value = false; }; template struct LLIsSameType { static const bool value = true; }; // workaround for decltype() not existing and typeof() not working inline in gcc 4.2 template struct LLResultTypeAdd { typedef LL_TYPEOF(S() + T()) type_t; }; template struct LLResultTypeSubtract { typedef LL_TYPEOF(S() - T()) type_t; }; template struct LLResultTypeMultiply { typedef LL_TYPEOF(S() * T()) type_t; }; template struct LLResultTypeDivide { typedef LL_TYPEOF(S() / T(1)) type_t; }; template struct LLUnit { typedef LLUnit self_t; typedef STORAGE_TYPE storage_t; // value initialization explicit LLUnit(storage_t value = storage_t()) : mValue(value) {} // unit initialization and conversion template LLUnit(LLUnit other) : mValue(convert(other).mValue) {} // unit assignment template self_t& operator = (LLUnit other) { mValue = convert(other).mValue; return *this; } storage_t value() const { return mValue; } void value(storage_t value) { mValue = value; } template storage_t valueInUnits() { return LLUnit(*this).value(); } template void valueInUnits(storage_t value) { *this = LLUnit(value); } template void operator += (LLUnit other) { mValue += convert(other).mValue; } template void operator -= (LLUnit other) { mValue -= convert(other).mValue; } void operator *= (storage_t multiplicand) { mValue *= multiplicand; } template void operator *= (LLUnit multiplicand) { // spurious use of dependent type to stop gcc from triggering the static assertion before instantiating the template LL_BAD_TEMPLATE_INSTANTIATION(OTHER_UNIT, "Multiplication of unit types not supported."); } void operator /= (storage_t divisor) { mValue /= divisor; } template void operator /= (LLUnit divisor) { // spurious use of dependent type to stop gcc from triggering the static assertion before instantiating the template LL_BAD_TEMPLATE_INSTANTIATION(OTHER_UNIT, "Illegal in-place division of unit types."); } template static self_t convert(LLUnit v) { self_t result; ll_convert_units(v, result); return result; } protected: storage_t mValue; }; template std::ostream& operator <<(std::ostream& s, const LLUnit& unit) { s << unit.value() << UNIT_TYPE::getUnitLabel(); return s; } template std::istream& operator >>(std::istream& s, LLUnit& unit) { STORAGE_TYPE val; s >> val; unit.value(val); return s; } template struct LLUnitImplicit : public LLUnit { typedef LLUnitImplicit self_t; typedef typename LLUnit::storage_t storage_t; typedef LLUnit base_t; LLUnitImplicit(storage_t value = storage_t()) : base_t(value) {} template LLUnitImplicit(LLUnit other) : base_t(convert(other)) {} // unlike LLUnit, LLUnitImplicit is *implicitly* convertable to a POD value (F32, S32, etc) // this allows for interoperability with legacy code operator storage_t() const { return base_t::value(); } using base_t::operator +=; void operator += (storage_t value) { base_t::mValue += value; } template void operator += (LLUnitImplicit other) { base_t::mValue += convert(other).value(); } using base_t::operator -=; void operator -= (storage_t value) { base_t::mValue -= value; } template void operator -= (LLUnitImplicit other) { base_t::mValue -= convert(other).value(); } }; template std::ostream& operator <<(std::ostream& s, const LLUnitImplicit& unit) { s << unit.value() << UNIT_TYPE::getUnitLabel(); return s; } template std::istream& operator >>(std::istream& s, LLUnitImplicit& unit) { STORAGE_TYPE val; s >> val; unit = val; return s; } template LL_FORCE_INLINE void ll_convert_units(LLUnit in, LLUnit& out, ...) { LL_STATIC_ASSERT((LLIsSameType::value || !LLIsSameType::value || !LLIsSameType::value), "invalid conversion: incompatible units"); if (LLIsSameType::value) { if (LLIsSameType::value) { // T1 and T2 fully reduced and equal...just copy out = LLUnit((S2)in.value()); } else { // reduce T2 LLUnit new_out; ll_convert_units(in, new_out); ll_convert_units(new_out, out); } } else { // reduce T1 LLUnit new_in; ll_convert_units(in, new_in); ll_convert_units(new_in, out); } } template struct LLStorageType { typedef T type_t; }; template struct LLStorageType > { typedef STORAGE_TYPE type_t; }; // // operator + // template LLUnit::type_t, UNIT_TYPE1> operator + (LLUnit first, LLUnit second) { LLUnit::type_t, UNIT_TYPE1> result(first); result += second; return result; } template LLUnit operator + (LLUnit first, UNITLESS second) { LL_BAD_TEMPLATE_INSTANTIATION(STORAGE_TYPE, "operator + requires compatible unit types"); return LLUnit(0); } template LLUnit operator + (UNITLESS first, LLUnit second) { LL_BAD_TEMPLATE_INSTANTIATION(STORAGE_TYPE, "operator + requires compatible unit types"); return LLUnit(0); } template LLUnitImplicit::type_t, UNIT_TYPE1> operator + (LLUnitImplicit first, LLUnitImplicit second) { LLUnitImplicit::type_t, UNIT_TYPE1> result(first); result += second; return result; } template LLUnitImplicit::type_t, UNIT_TYPE1> operator + (LLUnit first, LLUnitImplicit second) { LLUnitImplicit::type_t, UNIT_TYPE1> result(first); result += second; return result; } template LLUnitImplicit::type_t, UNIT_TYPE1> operator + (LLUnitImplicit first, LLUnit second) { LLUnitImplicit::type_t, UNIT_TYPE1> result(first); result += LLUnitImplicit(second); return result; } template LLUnitImplicit::type_t>::type_t, UNIT_TYPE> operator + (LLUnitImplicit first, UNITLESS_TYPE second) { LLUnitImplicit::type_t>::type_t, UNIT_TYPE> result(first); result += second; return result; } template LLUnitImplicit::type_t, STORAGE_TYPE>:: type_t, UNIT_TYPE> operator + (UNITLESS_TYPE first, LLUnitImplicit second) { LLUnitImplicit::type_t, STORAGE_TYPE>::type_t, UNIT_TYPE> result(first); result += second; return result; } // // operator - // template LLUnit::type_t, UNIT_TYPE1> operator - (LLUnit first, LLUnit second) { LLUnit::type_t, UNIT_TYPE1> result(first); result -= second; return result; } template LLUnit operator - (LLUnit first, UNITLESS second) { LL_BAD_TEMPLATE_INSTANTIATION(STORAGE_TYPE, "operator - requires compatible unit types"); return LLUnit(0); } template LLUnit operator - (UNITLESS first, LLUnit second) { LL_BAD_TEMPLATE_INSTANTIATION(STORAGE_TYPE, "operator - requires compatible unit types"); return LLUnit(0); } template LLUnitImplicit::type_t, UNIT_TYPE1> operator - (LLUnitImplicit first, LLUnitImplicit second) { LLUnitImplicit::type_t, UNIT_TYPE1> result(first); result -= second; return result; } template LLUnitImplicit::type_t, UNIT_TYPE1> operator - (LLUnit first, LLUnitImplicit second) { LLUnitImplicit::type_t, UNIT_TYPE1> result(first); result -= second; return result; } template LLUnitImplicit::type_t, UNIT_TYPE1> operator - (LLUnitImplicit first, LLUnit second) { LLUnitImplicit::type_t, UNIT_TYPE1> result(first); result -= LLUnitImplicit(second); return result; } template LLUnitImplicit::type_t>::type_t, UNIT_TYPE> operator - (LLUnitImplicit first, UNITLESS_TYPE second) { LLUnitImplicit::type_t>::type_t, UNIT_TYPE> result(first); result -= second; return result; } template LLUnitImplicit::type_t, STORAGE_TYPE>::type_t, UNIT_TYPE> operator - (UNITLESS_TYPE first, LLUnitImplicit second) { LLUnitImplicit::type_t, STORAGE_TYPE>::type_t, UNIT_TYPE> result(first); result -= second; return result; } // // operator * // template LLUnit operator * (LLUnit, LLUnit) { // spurious use of dependent type to stop gcc from triggering the static assertion before instantiating the template LL_BAD_TEMPLATE_INSTANTIATION(STORAGE_TYPE1, "multiplication of unit types results in new unit type - not supported."); return LLUnit(); } template LLUnit::type_t>::type_t, UNIT_TYPE> operator * (LLUnit first, UNITLESS_TYPE second) { return LLUnit::type_t>::type_t, UNIT_TYPE>(first.value() * second); } template LLUnit::type_t, STORAGE_TYPE>::type_t, UNIT_TYPE> operator * (UNITLESS_TYPE first, LLUnit second) { return LLUnit::type_t, STORAGE_TYPE>::type_t, UNIT_TYPE>(first * second.value()); } template LLUnitImplicit operator * (LLUnitImplicit, LLUnitImplicit) { // spurious use of dependent type to stop gcc from triggering the static assertion before instantiating the template LL_BAD_TEMPLATE_INSTANTIATION(STORAGE_TYPE1, "multiplication of unit types results in new unit type - not supported."); return LLUnitImplicit(); } template LLUnitImplicit::type_t>::type_t, UNIT_TYPE> operator * (LLUnitImplicit first, UNITLESS_TYPE second) { return LLUnitImplicit::type_t, UNIT_TYPE>(first.value() * second); } template LLUnitImplicit::type_t, STORAGE_TYPE>::type_t, UNIT_TYPE> operator * (UNITLESS_TYPE first, LLUnitImplicit second) { return LLUnitImplicit::type_t, STORAGE_TYPE>::type_t, UNIT_TYPE>(first * second.value()); } // // operator / // template LLUnit::type_t>::type_t, UNIT_TYPE> operator / (LLUnit first, UNITLESS_TYPE second) { return LLUnit::type_t>::type_t, UNIT_TYPE>(first.value() / second); } template typename LLResultTypeDivide::type_t operator / (LLUnit first, LLUnit second) { return first.value() / first.convert(second).value(); } template LLUnitImplicit::type_t>::type_t, UNIT_TYPE> operator / (LLUnitImplicit first, UNITLESS_TYPE second) { return LLUnitImplicit::type_t>::type_t, UNIT_TYPE>(first.value() / second); } template typename LLResultTypeDivide::type_t operator / (LLUnitImplicit first, LLUnitImplicit second) { return (typename LLResultTypeDivide::type_t)(first.value() / first.convert(second).value()); } template typename LLResultTypeDivide::type_t operator / (LLUnit first, LLUnitImplicit second) { return (typename LLResultTypeDivide::type_t)(first.value() / first.convert(second).value()); } template typename LLResultTypeDivide::type_t operator / (LLUnitImplicit first, LLUnit second) { return (typename LLResultTypeDivide::type_t)(first.value() / first.convert(second).value()); } // // comparison operators // #define LL_UNIT_DECLARE_COMPARISON_OPERATOR(op) \ template \ bool operator op (LLUnitImplicit first, LLUnitImplicit second) \ { \ return first.value() op first.convert(second).value(); \ } \ \ template \ bool operator op (LLUnitImplicit first, UNITLESS_TYPE second) \ { \ return first.value() op second; \ } \ \ template \ bool operator op (UNITLESS_TYPE first, LLUnitImplicit second) \ { \ return first op second.value(); \ } \ \ template \ bool operator op (LLUnit first, LLUnit second) \ { \ return first.value() op first.convert(second).value(); \ } \ \ template \ bool operator op (LLUnit first, UNITLESS_TYPE second) \ { \ LL_BAD_TEMPLATE_INSTANTIATION(UNITLESS_TYPE, "operator " #op " requires compatible unit types"); \ return false; \ } \ \ template \ bool operator op (UNITLESS_TYPE first, LLUnit second) \ { \ LL_BAD_TEMPLATE_INSTANTIATION(UNITLESS_TYPE, "operator " #op " requires compatible unit types"); \ return false; \ } \ \ template \ bool operator op (LLUnit first, LLUnitImplicit second) \ { \ return first.value() op first.convert(second).value(); \ } \ \ template \ bool operator op (LLUnitImplicit first, LLUnit second) \ { \ return first.value() op first.convert(second).value(); \ } LL_UNIT_DECLARE_COMPARISON_OPERATOR(<); LL_UNIT_DECLARE_COMPARISON_OPERATOR(<=); LL_UNIT_DECLARE_COMPARISON_OPERATOR(>); LL_UNIT_DECLARE_COMPARISON_OPERATOR(>=); LL_UNIT_DECLARE_COMPARISON_OPERATOR(==); LL_UNIT_DECLARE_COMPARISON_OPERATOR(!=); template struct LLGetUnitLabel { static const char* getUnitLabel() { return ""; } }; template struct LLGetUnitLabel > { static const char* getUnitLabel() { return T::getUnitLabel(); } }; template struct LLUnitLinearOps { typedef LLUnitLinearOps output_t; LLUnitLinearOps(INPUT_TYPE val) : mInput (val) {} operator OUTPUT_TYPE() const { return (OUTPUT_TYPE)mInput; } INPUT_TYPE mInput; template output_t operator * (T other) { return typename LLResultTypeMultiply::type_t(mInput) * other; } template output_t operator / (T other) { return typename LLResultTypeDivide::type_t(mInput) / other; } template output_t operator + (T other) { return typename LLResultTypeAdd::type_t(mInput) + other; } template output_t operator - (T other) { return typename LLResultTypeSubtract::type_t(mInput) - other; } }; template struct LLUnitInverseLinearOps { typedef LLUnitInverseLinearOps output_t; LLUnitInverseLinearOps(INPUT_TYPE val) : mInput(val) {} operator OUTPUT_TYPE() const { return (OUTPUT_TYPE)mInput; } INPUT_TYPE mInput; template output_t operator * (T other) { return typename LLResultTypeDivide::type_t(mInput) / other; } template output_t operator / (T other) { return typename LLResultTypeMultiply::type_t(mInput) * other; } template output_t operator + (T other) { return typename LLResultTypeAdd::type_t(mInput) - other; } template output_t operator - (T other) { return typename LLResultTypeSubtract::type_t(mInput) + other; } }; #define LL_DECLARE_BASE_UNIT(base_unit_name, unit_label) \ struct base_unit_name \ { \ typedef base_unit_name base_unit_t; \ static const char* getUnitLabel() { return unit_label; } \ template \ static LLUnit fromValue(T value) { return LLUnit(value); } \ template \ static LLUnit fromValue(LLUnit value) \ { return LLUnit(value); } \ } #define LL_DECLARE_DERIVED_UNIT(base_unit_name, conversion_operation, unit_name, unit_label) \ struct unit_name \ { \ typedef base_unit_name base_unit_t; \ static const char* getUnitLabel() { return unit_label; } \ template \ static LLUnit fromValue(T value) { return LLUnit(value); } \ template \ static LLUnit fromValue(LLUnit value) \ { return LLUnit(value); } \ }; \ \ template \ void ll_convert_units(LLUnit in, LLUnit& out) \ { \ out = LLUnit((S2)(LLUnitLinearOps(in.value()) conversion_operation)); \ } \ \ template \ void ll_convert_units(LLUnit in, LLUnit& out) \ { \ out = LLUnit((S2)(LLUnitInverseLinearOps(in.value()) conversion_operation)); \ } #define LL_DECLARE_UNIT_TYPEDEFS(ns, unit_name) \ typedef LLUnit F32##unit_name; \ typedef LLUnitImplicit F32##unit_name##Implicit;\ typedef LLUnit F64##unit_name; \ typedef LLUnitImplicit F64##unit_name##Implicit;\ typedef LLUnit S32##unit_name; \ typedef LLUnitImplicit S32##unit_name##Implicit;\ typedef LLUnit S64##unit_name; \ typedef LLUnitImplicit S64##unit_name##Implicit;\ typedef LLUnit U32##unit_name; \ typedef LLUnitImplicit U32##unit_name##Implicit;\ typedef LLUnit U64##unit_name; \ typedef LLUnitImplicit U64##unit_name##Implicit // // Unit declarations // namespace LLUnits { LL_DECLARE_BASE_UNIT(Bytes, "B"); // technically, these are kibibytes, mibibytes, etc. but we should stick with commonly accepted terminology LL_DECLARE_DERIVED_UNIT(Bytes, * 1024, Kilobytes, "KB"); LL_DECLARE_DERIVED_UNIT(Kilobytes, * 1024, Megabytes, "MB"); LL_DECLARE_DERIVED_UNIT(Megabytes, * 1024, Gigabytes, "GB"); } LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Bytes); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Kilobytes); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Megabytes); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Gigabytes); namespace LLUnits { // technically, these are kibibits, mibibits, etc. but we should stick with commonly accepted terminology LL_DECLARE_DERIVED_UNIT(Bytes, / 8, Bits, "b"); LL_DECLARE_DERIVED_UNIT(Bits, * 1024, Kilobits, "Kb"); LL_DECLARE_DERIVED_UNIT(Kilobits, * 1024, Megabits, "Mb"); LL_DECLARE_DERIVED_UNIT(Megabits, * 1024, Gigabits, "Gb"); } LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Bits); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Kilobits); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Megabits); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Gigabits); namespace LLUnits { LL_DECLARE_BASE_UNIT(Seconds, "s"); LL_DECLARE_DERIVED_UNIT(Seconds, * 60, Minutes, "min"); LL_DECLARE_DERIVED_UNIT(Minutes, * 60, Hours, "h"); LL_DECLARE_DERIVED_UNIT(Hours, * 24, Days, "d"); LL_DECLARE_DERIVED_UNIT(Seconds, / 1000, Milliseconds, "ms"); LL_DECLARE_DERIVED_UNIT(Milliseconds, / 1000, Microseconds, "\x09\x3cs"); LL_DECLARE_DERIVED_UNIT(Microseconds, / 1000, Nanoseconds, "ns"); } LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Seconds); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Minutes); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Hours); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Days); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Milliseconds); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Microseconds); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Nanoseconds); namespace LLUnits { LL_DECLARE_BASE_UNIT(Meters, "m"); LL_DECLARE_DERIVED_UNIT(Meters, * 1000, Kilometers, "km"); LL_DECLARE_DERIVED_UNIT(Meters, / 100, Centimeters, "cm"); LL_DECLARE_DERIVED_UNIT(Meters, / 1000, Millimeters, "mm"); } LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Meters); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Kilometers); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Centimeters); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Millimeters); namespace LLUnits { // rare units LL_DECLARE_BASE_UNIT(Hertz, "Hz"); LL_DECLARE_DERIVED_UNIT(Hertz, * 1000, Kilohertz, "KHz"); LL_DECLARE_DERIVED_UNIT(Kilohertz, * 1000, Megahertz, "MHz"); LL_DECLARE_DERIVED_UNIT(Megahertz, * 1000, Gigahertz, "GHz"); LL_DECLARE_BASE_UNIT(Radians, "rad"); LL_DECLARE_DERIVED_UNIT(Radians, / 57.29578f, Degrees, "deg"); LL_DECLARE_BASE_UNIT(Percent, "%"); LL_DECLARE_DERIVED_UNIT(Percent, * 100, Ratio, "x"); LL_DECLARE_BASE_UNIT(Triangles, "tris"); LL_DECLARE_DERIVED_UNIT(Triangles, * 1000, Kilotriangles, "ktris"); } // namespace LLUnits // rare units LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Hertz); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Kilohertz); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Megahertz); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Gigahertz); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Radians); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Degrees); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Percent); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Ratio); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Triangles); LL_DECLARE_UNIT_TYPEDEFS(LLUnits, Kilotriangles); #endif // LL_LLUNIT_H