LLVMCodeBuilder: Implement log10 operator

Author: adazem009

src/dev/engine/internal/icodebuilder.h

@@ -50,6 +50,7 @@ class ICodeBuilder
         virtual void createAcos() = 0;
         virtual void createAtan() = 0;
         virtual void createLn() = 0;
+        virtual void createLog10() = 0;
 
         virtual void beginIfStatement() = 0;
         virtual void beginElseBranch() = 0;

src/dev/engine/internal/llvmcodebuilder.cpp

@@ -364,6 +364,16 @@ std::shared_ptr<ExecutableCode> LLVMCodeBuilder::finalize()
                 break;
             }
 
+            case Step::Type::Log10: {
+                assert(step.args.size() == 1);
+                const auto &arg = step.args[0];
+                // log10(x)
+                llvm::Function *log10Func = llvm::Intrinsic::getDeclaration(m_module.get(), llvm::Intrinsic::log10, m_builder.getDoubleTy());
+                llvm::Value *num = removeNaN(castValue(arg.second, arg.first));
+                step.functionReturnReg->value = m_builder.CreateCall(log10Func, num);
+                break;
+            }
+
             case Step::Type::Yield:
                 if (!m_warp) {
                     freeHeap();
@@ -797,6 +807,11 @@ void LLVMCodeBuilder::createLn()
     createOp(Step::Type::Ln, Compiler::StaticType::Number, Compiler::StaticType::Number, 1);
 }
 
+void LLVMCodeBuilder::createLog10()
+{
+    createOp(Step::Type::Log10, Compiler::StaticType::Number, Compiler::StaticType::Number, 1);
+}
+
 void LLVMCodeBuilder::beginIfStatement()
 {
     Step step(Step::Type::BeginIf);

src/dev/engine/internal/llvmcodebuilder.h

@@ -52,6 +52,7 @@ class LLVMCodeBuilder : public ICodeBuilder
         void createAcos() override;
         void createAtan() override;
         void createLn() override;
+        void createLog10() override;
 
         void beginIfStatement() override;
         void beginElseBranch() override;
@@ -108,6 +109,7 @@ class LLVMCodeBuilder : public ICodeBuilder
                     Acos,
                     Atan,
                     Ln,
+                    Log10,
                     Yield,
                     BeginIf,
                     BeginElse,

test/dev/llvm/llvmcodebuilder_test.cpp

@@ -1646,6 +1646,50 @@ TEST_F(LLVMCodeBuilderTest, Ln)
     addOpTest(nan, -inf);
 }
 
+TEST_F(LLVMCodeBuilderTest, Log10)
+{
+    std::string expected;
+
+    auto addOpTest = [this, &expected](Value v1, double expectedResult) {
+        createBuilder(true);
+
+        m_builder->addConstValue(v1);
+        m_builder->createLog10();
+        m_builder->addFunctionCall("test_print_number", Compiler::StaticType::Void, { Compiler::StaticType::Number });
+
+        m_builder->addConstValue(v1);
+        m_builder->addFunctionCall("test_const_number", Compiler::StaticType::Number, { Compiler::StaticType::Number });
+        m_builder->createLog10();
+        m_builder->addFunctionCall("test_print_number", Compiler::StaticType::Void, { Compiler::StaticType::Number });
+
+        std::stringstream stream;
+        stream << expectedResult;
+        std::string str = stream.str() + '\n';
+        std::string expected = str + str;
+
+        auto code = m_builder->finalize();
+        auto ctx = code->createExecutionContext(&m_target);
+
+        testing::internal::CaptureStdout();
+        code->run(ctx.get());
+        const std::string quotes1 = v1.isString() ? "\"" : "";
+        ASSERT_THAT(testing::internal::GetCapturedStdout(), Eq(expected)) << quotes1 << v1.toString() << quotes1;
+    };
+
+    static const double inf = std::numeric_limits<double>::infinity();
+    static const double nan = std::numeric_limits<double>::quiet_NaN();
+
+    addOpTest(10.0, 1.0);
+    addOpTest(1000.0, 3.0);
+    addOpTest(0.01, -2.0);
+    addOpTest(0.0, -inf);
+    addOpTest(-0.0, -inf);
+    addOpTest(-0.7, nan);
+    addOpTest(inf, inf);
+    addOpTest(-inf, nan);
+    addOpTest(nan, -inf);
+}
+
 TEST_F(LLVMCodeBuilderTest, Yield)
 {
     auto build = [this]() {

test/mocks/codebuildermock.h

@@ -40,6 +40,7 @@ class CodeBuilderMock : public ICodeBuilder
         MOCK_METHOD(void, createAcos, (), (override));
         MOCK_METHOD(void, createAtan, (), (override));
         MOCK_METHOD(void, createLn, (), (override));
+        MOCK_METHOD(void, createLog10, (), (override));
 
         MOCK_METHOD(void, beginIfStatement, (), (override));
         MOCK_METHOD(void, beginElseBranch, (), (override));