From 09899902e876a27349ef6d55f84ee7d61d37d1e6 Mon Sep 17 00:00:00 2001
From: Alexis Montoison <alexis.montoison@polymtl.ca>
Date: Fri, 1 Sep 2023 11:54:33 -0400
Subject: [PATCH] Add an example for MINARES

---
 docs/src/examples/minares.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 docs/src/examples/minares.md

diff --git a/docs/src/examples/minares.md b/docs/src/examples/minares.md
new file mode 100644
index 000000000..cbcacbe61
--- /dev/null
+++ b/docs/src/examples/minares.md
@@ -0,0 +1,19 @@
+```@example minares
+using Krylov, MatrixMarket, SuiteSparseMatrixCollection
+using LinearAlgebra, Printf
+
+ssmc = ssmc_db(verbose=false)
+matrix = ssmc_matrices(ssmc, "GHS_indef", "laser")
+path = fetch_ssmc(matrix, format="MM")
+
+n = matrix.nrows[1]
+A = MatrixMarket.mmread(joinpath(path[1], "$(matrix.name[1]).mtx"))
+b = ones(n)
+
+# Solve Ax = b.
+x, stats = minares(A, b)
+show(stats)
+r = b - A * x
+Ar = A * r
+@printf("Relative A-residual: %8.1e\n", norm(A * r) / norm(A * b))
+```