1 /*
2  * Copyright (c) 2011-2015, Intel Corporation
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation and/or
13  * other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #include "LogarithmicParameterAdaptation.h"
32 #include <cmath>
33 #include <limits>
34 #include <algorithm>
35 
36 #define base CLinearParameterAdaptation
37 
CLogarithmicParameterAdaptation()38 CLogarithmicParameterAdaptation::CLogarithmicParameterAdaptation() : base("Logarithmic")
39 {
40     static_assert(std::numeric_limits<double>::is_iec559,
41                   "Only double-precision floating points that are compliant with"
42                   " IEC 559 (aka IEEE 754) are supported");
43 }
44 
45 // Element properties
showProperties(std::string & strResult) const46 void CLogarithmicParameterAdaptation::showProperties(std::string &strResult) const
47 {
48     base::showProperties(strResult);
49 
50     strResult += " - LogarithmBase: ";
51     strResult += std::to_string(_dLogarithmBase);
52     strResult += "\n";
53     strResult += " - FloorValue: ";
54     strResult += std::to_string(_dFloorValue);
55     strResult += "\n";
56 }
57 
fromXml(const CXmlElement & xmlElement,CXmlSerializingContext & serializingContext)58 bool CLogarithmicParameterAdaptation::fromXml(const CXmlElement &xmlElement,
59                                               CXmlSerializingContext &serializingContext)
60 {
61     if (xmlElement.getAttribute("LogarithmBase", _dLogarithmBase) &&
62         (_dLogarithmBase <= 0 || _dLogarithmBase == 1)) {
63         // Avoid negative and 1 values
64         serializingContext.setError("LogarithmBase attribute cannot be negative or 1 on element" +
65                                     xmlElement.getPath());
66 
67         return false;
68     }
69 
70     xmlElement.getAttribute("FloorValue", _dFloorValue);
71 
72     // Base
73     return base::fromXml(xmlElement, serializingContext);
74 }
75 
fromUserValue(double value) const76 int64_t CLogarithmicParameterAdaptation::fromUserValue(double value) const
77 {
78     return std::max(base::fromUserValue(log(value) / log(_dLogarithmBase)),
79                     static_cast<int64_t>(_dFloorValue));
80 }
81 
toUserValue(int64_t iValue) const82 double CLogarithmicParameterAdaptation::toUserValue(int64_t iValue) const
83 {
84     return exp(base::toUserValue(iValue) * log(_dLogarithmBase));
85 }
86