review update

* Rename multiprecision -> mixed precision * Improve documentation and output * Improve code style Co-authored-by: Hartwig Anzt <hanzt@icl.utk.edu> Co-authored-by: Yuhsiang M. Tsai <yhmtsai@gmail.com> Co-authored-by: Pratik Nayak <pratikvn@protonmail.com> Co-authored-by: Terry Cojean <terry.cojean@kit.edu>
ginkgo-project · upsj · May 4, 2020 · May 4, 2020 · May 4, 2020 · May 4, 2020
commit c373ed06e203196fc54b06dcaee4c0400b1bd5bc
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -12,7 +12,7 @@ add_subdirectory(ilu-preconditioned-solver)
 add_subdirectory(inverse-iteration)
 add_subdirectory(iterative-refinement)
 add_subdirectory(minimal-cuda-solver)
-add_subdirectory(multiprecision-ir)
+add_subdirectory(mixed-precision-ir)
 add_subdirectory(nine-pt-stencil-solver)
 add_subdirectory(papi-logging)
 add_subdirectory(performance-debugging)

diff --git a/examples/mixed-precision-ir/CMakeLists.txt b/examples/mixed-precision-ir/CMakeLists.txt
@@ -0,0 +1,4 @@
+add_executable(mixed-precision-ir mixed-precision-ir.cpp)
+target_link_libraries(mixed-precision-ir ginkgo)
+target_include_directories(mixed-precision-ir PRIVATE ${PROJECT_SOURCE_DIR})
+configure_file(data/A.mtx data/A.mtx COPYONLY)
diff --git a/examples/multiprecision-ir/build.sh → examples/mixed-precision-ir/build.sh b/examples/multiprecision-ir/build.sh → examples/mixed-precision-ir/build.sh
@@ -32,7 +32,7 @@ if [ -z "${CXX}" ]; then
 fi
 
 # build
-${CXX} -std=c++11 -o ${THIS_DIR}/multiprecision-ir \
-    ${THIS_DIR}/multiprecision-ir.cpp \
+${CXX} -std=c++11 -o ${THIS_DIR}/mixed-precision-ir \
+    ${THIS_DIR}/mixed-precision-ir.cpp \
     -I${THIS_DIR}/../../include -I${BUILD_DIR}/include \
     -L${THIS_DIR} ${LINK_FLAGS}
diff --git a/examples/multiprecision-ir/data/A.mtx → examples/mixed-precision-ir/data/A.mtx b/examples/multiprecision-ir/data/A.mtx → examples/mixed-precision-ir/data/A.mtx
diff --git a/examples/mixed-precision-ir/doc/builds-on b/examples/mixed-precision-ir/doc/builds-on
@@ -0,0 +1 @@
+iterative-refinement
diff --git a/examples/multiprecision-ir/doc/intro.dox → examples/mixed-precision-ir/doc/intro.dox b/examples/multiprecision-ir/doc/intro.dox → examples/mixed-precision-ir/doc/intro.dox
@@ -1,5 +1,5 @@
-<a name="Multiprecision Iterative Refinement"></a>
-<h1>This example manually implements a multiprecision iterative refinement solver.</h1>
+<a name="Mixed Precision Iterative Refinement (MPIR)"></a>
+<h1>This example manually implements a Mixed Precision Iterative Refinement (MPIR) solver.</h1>
 
 <h3> In this example, we first read in a matrix from file, then generate a
 right-hand side and an initial guess. An inaccurate CG solver in single precision

diff --git a/examples/mixed-precision-ir/doc/kind b/examples/mixed-precision-ir/doc/kind
@@ -0,0 +1 @@
+techniques
diff --git a/examples/multiprecision-ir/doc/results.dox → examples/mixed-precision-ir/doc/results.dox b/examples/multiprecision-ir/doc/results.dox → examples/mixed-precision-ir/doc/results.dox
@@ -3,16 +3,16 @@ This is the expected output:
 
 @code{.cpp}
 
-Initial residual norm sqrt(r^T r):
+Initial residual norm sqrt(r^T r): 
 %%MatrixMarket matrix array real general
 1 1
 194.679
-Final residual norm sqrt(r^T r):
+Final residual norm sqrt(r^T r): 
 %%MatrixMarket matrix array real general
 1 1
-4.23821e-11
-IR iteration count:     24
-IR execution time [ms]: 18.0692
+1.22728e-10
+MPIR iteration count:     25
+MPIR execution time [ms]: 18.0933
 
 @endcode
 

diff --git a/examples/mixed-precision-ir/doc/short-intro b/examples/mixed-precision-ir/doc/short-intro
@@ -0,0 +1 @@
+The Mixed Precision Iterative Refinement (MPIR) solver example.
diff --git a/examples/mixed-precision-ir/doc/tooltip b/examples/mixed-precision-ir/doc/tooltip
@@ -0,0 +1 @@
+Manually implement a Mixed Precision Iterative Refinement (MPIR) method in Ginkgo. Solve a linear system.
diff --git a/...s/multiprecision-ir/multiprecision-ir.cpp → ...mixed-precision-ir/mixed-precision-ir.cpp b/...s/multiprecision-ir/multiprecision-ir.cpp → ...mixed-precision-ir/mixed-precision-ir.cpp
@@ -81,13 +81,12 @@ int main(int argc, char *argv[])
     auto A = share(gko::read<mtx>(std::ifstream("data/A.mtx"), exec));
     // Create RHS and initial guess as 1
     gko::size_type size = A->get_size()[0];
-    auto host_x = gko::matrix::Dense<ValueType>::create(exec->get_master(),
-                                                        gko::dim<2>(size, 1));
+    auto host_x = vec::create(exec->get_master(), gko::dim<2>(size, 1));
     for (auto i = 0; i < size; i++) {
         host_x->at(i, 0) = 1.;
     }
-    auto x = gko::matrix::Dense<ValueType>::create(exec);
-    auto b = gko::matrix::Dense<ValueType>::create(exec);
+    auto x = vec::create(exec);
+    auto b = vec::create(exec);
     x->copy_from(host_x.get());
     b->copy_from(host_x.get());
 
@@ -172,7 +171,7 @@ int main(int argc, char *argv[])
     write(std::cout, lend(res_vec));
 
     // Print solver statistics
-    std::cout << "IR iteration count:     " << iter << std::endl;
-    std::cout << "IR execution time [ms]: "
+    std::cout << "MPIR iteration count:     " << iter << std::endl;
+    std::cout << "MPIR execution time [ms]: "
               << static_cast<double>(time.count()) / 1000000.0 << std::endl;
 }
diff --git a/examples/multiprecision-ir/CMakeLists.txt b/examples/multiprecision-ir/CMakeLists.txt
diff --git a/examples/multiprecision-ir/doc/builds-on b/examples/multiprecision-ir/doc/builds-on
diff --git a/examples/multiprecision-ir/doc/kind b/examples/multiprecision-ir/doc/kind
diff --git a/examples/multiprecision-ir/doc/short-intro b/examples/multiprecision-ir/doc/short-intro
diff --git a/examples/multiprecision-ir/doc/tooltip b/examples/multiprecision-ir/doc/tooltip
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		The Mixed Precision Iterative Refinement (MPIR) solver example.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Manually implement a Mixed Precision Iterative Refinement (MPIR) method in Ginkgo. Solve a linear system.