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 "Utility.h"
33 #include <math.h>
34
35 #define base CLinearParameterAdaptation
36
37 // M_E is the base of the natural logarithm for 'e' from math.h
CLogarithmicParameterAdaptation()38 CLogarithmicParameterAdaptation::CLogarithmicParameterAdaptation() : base("Logarithmic"),
39 _dLogarithmBase(M_E), _dFloorValue(-INFINITY)
40 {
41 }
42
43 // Element properties
showProperties(std::string & strResult) const44 void CLogarithmicParameterAdaptation::showProperties(std::string& strResult) const
45 {
46 base::showProperties(strResult);
47
48 strResult += " - LogarithmBase: ";
49 strResult += CUtility::toString(_dLogarithmBase);
50 strResult += "\n";
51 strResult += " - FloorValue: ";
52 strResult += CUtility::toString(_dFloorValue);
53 strResult += "\n";
54 }
55
fromXml(const CXmlElement & xmlElement,CXmlSerializingContext & serializingContext)56 bool CLogarithmicParameterAdaptation::fromXml(const CXmlElement& xmlElement,
57 CXmlSerializingContext& serializingContext)
58 {
59
60 if (xmlElement.hasAttribute("LogarithmBase")) {
61
62 _dLogarithmBase = xmlElement.getAttributeDouble("LogarithmBase");
63
64 // Avoid negative and 1 values
65 if (_dLogarithmBase <= 0 || _dLogarithmBase == 1) {
66 serializingContext.setError("LogarithmBase attribute cannot be negative or 1 on element"
67 + xmlElement.getPath());
68
69 return false;
70 }
71 }
72
73 if (xmlElement.hasAttribute("FloorValue")) {
74 _dFloorValue = xmlElement.getAttributeDouble("FloorValue");
75 }
76 // Base
77 return base::fromXml(xmlElement, serializingContext);
78 }
79
80
fromUserValue(double dValue) const81 int64_t CLogarithmicParameterAdaptation::fromUserValue(double dValue) const
82 {
83 return fmax(round(base::fromUserValue(log(dValue) / log(_dLogarithmBase))),
84 _dFloorValue);
85 }
86
toUserValue(int64_t iValue) const87 double CLogarithmicParameterAdaptation::toUserValue(int64_t iValue) const
88 {
89 return exp(base::toUserValue(iValue) * log(_dLogarithmBase));
90 }
91