Skip to content

Commit 749efe1

Browse files
committed
Alphabetic rearrangement of proximal ops
1 parent c95259e commit 749efe1

File tree

1 file changed

+50
-33
lines changed

1 file changed

+50
-33
lines changed

docs/source/api/index.rst

Lines changed: 50 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,22 @@ Orthogonal projections
1717
.. autosummary::
1818
:toctree: generated/
1919

20+
AffineSetProj
2021
BoxProj
22+
EuclideanBallProj
2123
HyperPlaneBoxProj
22-
SimplexProj
24+
IntersectionProj
2325
L0BallProj
2426
L1BallProj
25-
EuclideanBallProj
2627
NuclearBallProj
27-
IntersectionProj
28-
AffineSetProj
28+
SimplexProj
2929

3030
Proximal operators
3131
------------------
3232

3333
Templates
34-
~~~~~~~~~
34+
^^^^^^^^^
35+
3536
.. currentmodule:: pyproximal
3637

3738
.. autosummary::
@@ -46,44 +47,50 @@ Templates
4647

4748
moreau
4849

49-
50-
Operators
51-
~~~~~~~~~
52-
5350
.. currentmodule:: pyproximal
5451

5552
Vector
56-
``````
53+
^^^^^^
54+
55+
Convex
56+
~~~~~~
57+
5758
.. autosummary::
5859
:toctree: generated/
5960

60-
Box
61-
Simplex
62-
Intersection
6361
AffineSet
64-
Quadratic
62+
Box
6563
Euclidean
6664
EuclideanBall
65+
Huber
66+
Intersection
6767
L0Ball
6868
L1
6969
L1Ball
7070
L2
7171
L2Convolve
7272
L21
7373
L21_plus_L1
74-
Huber
75-
SCAD
76-
Log
74+
Orthogonal
75+
Quadratic
76+
Simplex
77+
78+
79+
Non-Convex
80+
~~~~~~~~~~
81+
82+
.. autosummary::
83+
:toctree: generated/
84+
7785
ETP
7886
Geman
87+
Log
7988
QuadraticEnvelopeCard
80-
Orthogonal
81-
Nonlinear
82-
VStack
89+
SCAD
8390

8491

8592
Matrix-only
86-
```````````
93+
^^^^^^^^^^^
8794

8895
.. autosummary::
8996
:toctree: generated/
@@ -93,6 +100,16 @@ Matrix-only
93100
SingularValuePenalty
94101

95102

103+
Other
104+
^^^^^
105+
106+
.. autosummary::
107+
:toctree: generated/
108+
109+
Nonlinear
110+
VStack
111+
112+
96113
Other operators
97114
---------------
98115

@@ -109,55 +126,55 @@ Solvers
109126
-------
110127

111128
Primal
112-
~~~~~~
129+
^^^^^^
113130

114131
.. currentmodule:: pyproximal.optimization.primal
115132

116133
.. autosummary::
117134
:toctree: generated/
118135

119-
ProximalPoint
120-
ProximalGradient
121136
AcceleratedProximalGradient
122137
ADMM
123138
LinearizedADMM
139+
ProximalGradient
140+
ProximalPoint
124141
TwIST
125142

126-
.. currentmodule:: pyproximal.optimization.sr3
143+
.. currentmodule:: pyproximal.optimization.palm
127144

128145
.. autosummary::
129146
:toctree: generated/
130147

131-
SR3
148+
PALM
132149

133-
.. currentmodule:: pyproximal.optimization.palm
150+
.. currentmodule:: pyproximal.optimization.pnp
134151

135152
.. autosummary::
136153
:toctree: generated/
137154

138-
PALM
155+
PlugAndPlay
139156

140-
.. currentmodule:: pyproximal.optimization.pnp
157+
.. currentmodule:: pyproximal.optimization.sr3
141158

142159
.. autosummary::
143160
:toctree: generated/
144161

145-
PlugAndPlay
162+
SR3
146163

147164

148165
Primal-dual
149-
~~~~~~~~~~~
166+
^^^^^^^^^^^
150167

151168
.. currentmodule:: pyproximal.optimization.primaldual
152169

153170
.. autosummary::
154171
:toctree: generated/
155172

156-
PrimalDual
157173
AdaptivePrimalDual
174+
PrimalDual
158175

159176
Other
160-
~~~~~
177+
^^^^^
161178

162179
.. currentmodule:: pyproximal.optimization.bregman
163180

0 commit comments

Comments
 (0)