Add a tutorial

.github/workflows/clang.yml

@@ -32,3 +32,22 @@ jobs:
         cd ../GPU
         make -j4 USE_CPU=TRUE COMP=clang
         ./main.llvm.ex
+
+  Tutorials:
+    name: Clang libamrexpr
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Dependencies
+      run: |
+        .github/workflows/dependencies/dependencies_clang.sh
+    - name: Build libamrexpr
+      run: |
+        ./configure --comp llvm
+        make -j4
+        make install
+    - name: Run
+      run: |
+        cd Tutorials/libamrexpr
+        make -j4 CXX=clang++
+        ./a.out

.github/workflows/gcc.yml

@@ -32,3 +32,22 @@ jobs:
         cd ../GPU
         make -j4 USE_CPU=TRUE
         ./main.gnu.ex
+
+  Tutorials:
+    name: Clang libamrexpr
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Dependencies
+      run: |
+        .github/workflows/dependencies/dependencies_gcc.sh
+    - name: Build libamrexpr
+      run: |
+        ./configure --comp gnu
+        make -j4
+        make install
+    - name: Run
+      run: |
+        cd Tutorials/libamrexpr
+        make -j4 CXX=g++
+        ./a.out

.github/workflows/intel.yml

@@ -36,3 +36,28 @@ jobs:
         cd ../GPU
         make -j4 USE_CPU=TRUE COMP=intel
         ./main.intel.ex
+
+  Tutorials:
+    name: Clang libamrexpr
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Dependencies
+      run: |
+        .github/workflows/dependencies/dependencies_dpcpp.sh
+    - name: Build libamrexpr
+      run: |
+        set +e
+        source /opt/intel/oneapi/setvars.sh
+        set -e
+        ./configure --comp intel
+        make -j4
+        make install
+    - name: Run
+      run: |
+        set +e
+        source /opt/intel/oneapi/setvars.sh
+        set -e
+        cd Tutorials/libamrexpr
+        make -j4 CXX=icpx
+        ./a.out

README.md

@@ -67,7 +67,8 @@ the constants set by `setConstant` and the variables registered by
 
 ## Installation
 
-There two ways to install amrexpr.
+There two ways to install `amrexpr`. A simple example demonstrating the use
+of `libamrexpr` is available at `amrexpr/Tutorials/libamrexpr`.
 
 ### Option 1: Using GNU Make
 

Tutorials/libamrexpr/GNUmakefile

@@ -0,0 +1,17 @@
+AMREXPR_ROOT = ../../tmp_install_dir
+
+CXX = g++
+CXXFLAGS = -std=c++17 -O3 -g1 -I$(AMREXPR_ROOT)/include
+
+default: a.out
+
+a.out: main.o
+	$(CXX) $(CXXFLAGS) $^ -L$(AMREXPR_ROOT)/lib -lamrexpr
+
+main.o: main.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<
+
+.PHONY: clean
+
+clean:
+	$(RM) main.o a.out

Tutorials/libamrexpr/main.cpp

@@ -0,0 +1,16 @@
+#include "amrexpr.hpp"
+#include <iostream>
+
+int main (int argc, char* argv[])
+{
+    amrexpr::Parser parser("a*x + b*y");
+    parser.setConstant("a", 4.0);
+    parser.setConstant("b", 2.0);
+    parser.registerVariables({"x","y"});
+    auto f = parser.compile<2>(); // 2: two variables
+    double x = 10.0;
+    double y = 1.0;
+    double result = f(x,y);
+    std::cout << "f(x,y) = " << parser.expr() << "\n"
+              << "f(" << x << "," << y << ") = " << result << "\n";
+}