From 107618909d9fe836d8310bb1744c1604c43234e9 Mon Sep 17 00:00:00 2001 From: Tim Kelley Date: Sun, 25 Aug 2024 17:26:15 -0400 Subject: [PATCH] Tweak docs in internal solvers. --- .github/workflows/ci.yml | 8 ++++---- src/Solvers/LinearSolvers/Orthogonalize!.jl | 8 ++++++++ 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8b28f73d..bcc32682 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -20,14 +20,14 @@ jobs: fail-fast: false matrix: version: -# - '1.6' # LTS +# - '1.10' # LTS - '1' # Current stable release - '~1.11.0-0' -# - 'nightly' + - 'nightly' os: - - ubuntu-latest +# - ubuntu-latest - macOS-latest - - windows-latest +# - windows-latest arch: - x64 steps: diff --git a/src/Solvers/LinearSolvers/Orthogonalize!.jl b/src/Solvers/LinearSolvers/Orthogonalize!.jl index 4dee644b..b3a9e13e 100644 --- a/src/Solvers/LinearSolvers/Orthogonalize!.jl +++ b/src/Solvers/LinearSolvers/Orthogonalize!.jl @@ -8,7 +8,15 @@ methods. Anything other than classical Gram-Schmidt twice (cgs2) is likely to become an undocumented and UNSUPPORTED option. Methods other than cgs2 are mostly for CI for the linear solver. +This orthogonalizes the vector vv against the columns of V +and stores the coefficients in the vector hv. You preallocate +hv. The length of hv is the number of columns of VV + 1. vv is +overwritten by the orthogonalized unit vector. + DO NOT use anything other than "cgs2" with Anderson acceleration. + +I do not export this function, but use it in my own work and in +the new MultiPrecisionArrays package. """ function Orthogonalize!(V, hv, vv, orth = "cgs2"; verbose = false) orthopts = ["mgs1", "mgs2", "cgs1", "cgs2"]