From 0a41b9d1b03271de4c2cd5f436b3c0a95bd6d7b1 Mon Sep 17 00:00:00 2001 From: nHackel Date: Wed, 22 Nov 2023 11:12:05 +0100 Subject: [PATCH] Fix doctests --- docs/src/API/regularization.md | 4 ++-- docs/src/regularization.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/API/regularization.md b/docs/src/API/regularization.md index 896d9991..49bf2e23 100644 --- a/docs/src/API/regularization.md +++ b/docs/src/API/regularization.md @@ -29,7 +29,7 @@ RegularizedLeastSquares.RealRegularization ## Nested Regularization ```@docs -RegularizedLeastSquares.inner(::AbstractNestedRegularization) +RegularizedLeastSquares.innerreg(::AbstractNestedRegularization) RegularizedLeastSquares.sink(::AbstractNestedRegularization) RegularizedLeastSquares.sinktype(::AbstractNestedRegularization) ``` @@ -37,7 +37,7 @@ RegularizedLeastSquares.sinktype(::AbstractNestedRegularization) ## Scaled Regularization ```@docs RegularizedLeastSquares.AbstractScaledRegularization -RegularizedLeastSquares.factor +RegularizedLeastSquares.scalefactor RegularizedLeastSquares.NormalizedRegularization RegularizedLeastSquares.NoNormalization RegularizedLeastSquares.MeasurementBasedNormalization diff --git a/docs/src/regularization.md b/docs/src/regularization.md index b7372765..bc10f239 100644 --- a/docs/src/regularization.md +++ b/docs/src/regularization.md @@ -79,7 +79,7 @@ julia> prox!(reg, randn(32*32)); # Apply soft-thresholding in Wavelet domain ``` The type of regularization term a nested term can be wrapped around depends on the concrete type of the nested term. However generally, they can be nested arbitrarly deep, adding new functionality with each layer. Each nested regularization term can return its `inner` regularization. Furthermore, all regularization terms implement the iteration interface to iterate over the nesting. The innermost regularization term of a nested term must be a core regularization term and it can be returned by the `sink` function: ```jldoctest wavelet -julia> inner(reg) == core +julia> innerreg(reg) == core true julia> sink(reg) == core