Add log10 expression

Issue #72
rakhimov · Apr 25, 2017 · d47ca13 · d47ca13
1 parent f33f74b
commit d47ca13
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 1 deletion.
diff --git a/share/input.rng b/share/input.rng
@@ -736,6 +736,9 @@
       <element name="log">
         <ref name="expression"/>
       </element>
+      <element name="log10">
+        <ref name="expression"/>
+      </element>
       <element name="sin">
         <ref name="expression"/>
       </element>

diff --git a/src/expression/numerical.cc b/src/expression/numerical.cc
@@ -59,5 +59,12 @@ void ValidateExpression<Functor<&std::log>>(
   EnsurePositive<InvalidArgument>(args.front(), "Natural Logarithm");
 }
 
+template <>
+void ValidateExpression<Functor<&std::log10>>(
+    const std::vector<Expression*>& args) {
+  assert(args.size() == 1);
+  EnsurePositive<InvalidArgument>(args.front(), "Decimal Logarithm");
+}
+
 }  // namespace mef
 }  // namespace scram
diff --git a/src/expression/numerical.h b/src/expression/numerical.h
@@ -57,6 +57,9 @@ void ValidateExpression<Functor<&std::asin>>(
 template <>
 void ValidateExpression<Functor<&std::log>>(
     const std::vector<Expression*>& args);
+template <>
+void ValidateExpression<Functor<&std::log10>>(
+    const std::vector<Expression*>& args);
 /// @}
 
 /// Interval specialization for math functions.
@@ -102,6 +105,7 @@ using Sinh = FunctorExpression<&std::sinh>;  ///< Hyperbolic sine.
 using Tanh = FunctorExpression<&std::tanh>;  ///< Hyperbolic tangent.
 using Exp = FunctorExpression<&std::exp>;  ///< Exponential.
 using Log = FunctorExpression<&std::log>;  ///< Natural logarithm.
+using Log10 = FunctorExpression<&std::log10>;  ///< Decimal logarithm.
 
 }  // namespace mef
 }  // namespace scram

diff --git a/src/initializer.cc b/src/initializer.cc
@@ -815,7 +815,8 @@ const Initializer::ExtractorMap Initializer::kExpressionExtractors_ = {
     {"sinh", &Extract<Sinh>},
     {"tanh", &Extract<Tanh>},
     {"exp", &Extract<Exp>},
-    {"log", &Extract<Log>}};
+    {"log", &Extract<Log>},
+    {"log10", &Extract<Log10>}};
 
 Expression* Initializer::GetExpression(const xmlpp::Element* expr_element,
                                        const std::string& base_path) {

diff --git a/tests/expression_tests.cc b/tests/expression_tests.cc
@@ -860,6 +860,29 @@ TEST(ExpressionTest, Log) {
   EXPECT_NO_THROW(dev->Validate());
 }
 
+TEST(ExpressionTest, Log10) {
+  OpenExpression arg_one(1);
+  std::unique_ptr<Expression> dev;
+  ASSERT_NO_THROW(dev = std::make_unique<Log10>(&arg_one));
+  EXPECT_DOUBLE_EQ(0, dev->value());
+  arg_one.mean = 10;
+  EXPECT_DOUBLE_EQ(1, dev->value());
+
+  arg_one.mean = -1;
+  EXPECT_THROW(dev->Validate(), InvalidArgument);
+  arg_one.mean = 0;
+  EXPECT_THROW(dev->Validate(), InvalidArgument);
+  arg_one.mean = 1;
+  EXPECT_NO_THROW(dev->Validate());
+
+  arg_one.sample = arg_one.min = 0;
+  arg_one.max = 1;
+  EXPECT_THROW(dev->Validate(), InvalidArgument);
+  arg_one.min = 0.5;
+  arg_one.max = 1;
+  EXPECT_NO_THROW(dev->Validate());
+}
+
 }  // namespace test
 }  // namespace mef
 }  // namespace scram
diff --git a/tests/input/fta/correct_expressions.xml b/tests/input/fta/correct_expressions.xml
@@ -247,5 +247,10 @@ The input tries to utilize all the functionality including optional cases.
         <float value="1"/>
       </log>
     </define-parameter>
+    <define-parameter name="Log10">
+      <log10>
+        <float value="1"/>
+      </log10>
+    </define-parameter>
   </model-data>
 </opsa-mef>