Skip to content

Commit

Permalink
Fix doctests
Browse files Browse the repository at this point in the history
  • Loading branch information
nHackel committed Nov 22, 2023
1 parent be1ac35 commit 0a41b9d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/src/API/regularization.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ RegularizedLeastSquares.RealRegularization

## Nested Regularization
```@docs
RegularizedLeastSquares.inner(::AbstractNestedRegularization)
RegularizedLeastSquares.innerreg(::AbstractNestedRegularization)
RegularizedLeastSquares.sink(::AbstractNestedRegularization)
RegularizedLeastSquares.sinktype(::AbstractNestedRegularization)
```

## Scaled Regularization
```@docs
RegularizedLeastSquares.AbstractScaledRegularization
RegularizedLeastSquares.factor
RegularizedLeastSquares.scalefactor
RegularizedLeastSquares.NormalizedRegularization
RegularizedLeastSquares.NoNormalization
RegularizedLeastSquares.MeasurementBasedNormalization
Expand Down
2 changes: 1 addition & 1 deletion docs/src/regularization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0a41b9d

Please sign in to comment.