scs 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +12 -0
  3. data/LICENSE.txt +22 -0
  4. data/README.md +98 -0
  5. data/ext/scs/extconf.rb +29 -0
  6. data/lib/scs.rb +17 -0
  7. data/lib/scs/ffi.rb +117 -0
  8. data/lib/scs/solver.rb +173 -0
  9. data/lib/scs/version.rb +3 -0
  10. data/vendor/scs/LICENSE.txt +21 -0
  11. data/vendor/scs/Makefile +164 -0
  12. data/vendor/scs/README.md +222 -0
  13. data/vendor/scs/include/aa.h +56 -0
  14. data/vendor/scs/include/cones.h +46 -0
  15. data/vendor/scs/include/ctrlc.h +33 -0
  16. data/vendor/scs/include/glbopts.h +177 -0
  17. data/vendor/scs/include/linalg.h +26 -0
  18. data/vendor/scs/include/linsys.h +64 -0
  19. data/vendor/scs/include/normalize.h +18 -0
  20. data/vendor/scs/include/rw.h +17 -0
  21. data/vendor/scs/include/scs.h +161 -0
  22. data/vendor/scs/include/scs_blas.h +51 -0
  23. data/vendor/scs/include/util.h +65 -0
  24. data/vendor/scs/linsys/amatrix.c +305 -0
  25. data/vendor/scs/linsys/amatrix.h +36 -0
  26. data/vendor/scs/linsys/amatrix.o +0 -0
  27. data/vendor/scs/linsys/cpu/direct/private.c +366 -0
  28. data/vendor/scs/linsys/cpu/direct/private.h +26 -0
  29. data/vendor/scs/linsys/cpu/direct/private.o +0 -0
  30. data/vendor/scs/linsys/cpu/indirect/private.c +256 -0
  31. data/vendor/scs/linsys/cpu/indirect/private.h +31 -0
  32. data/vendor/scs/linsys/cpu/indirect/private.o +0 -0
  33. data/vendor/scs/linsys/external/amd/LICENSE.txt +934 -0
  34. data/vendor/scs/linsys/external/amd/SuiteSparse_config.c +469 -0
  35. data/vendor/scs/linsys/external/amd/SuiteSparse_config.h +254 -0
  36. data/vendor/scs/linsys/external/amd/SuiteSparse_config.o +0 -0
  37. data/vendor/scs/linsys/external/amd/amd.h +400 -0
  38. data/vendor/scs/linsys/external/amd/amd_1.c +180 -0
  39. data/vendor/scs/linsys/external/amd/amd_1.o +0 -0
  40. data/vendor/scs/linsys/external/amd/amd_2.c +1842 -0
  41. data/vendor/scs/linsys/external/amd/amd_2.o +0 -0
  42. data/vendor/scs/linsys/external/amd/amd_aat.c +184 -0
  43. data/vendor/scs/linsys/external/amd/amd_aat.o +0 -0
  44. data/vendor/scs/linsys/external/amd/amd_control.c +64 -0
  45. data/vendor/scs/linsys/external/amd/amd_control.o +0 -0
  46. data/vendor/scs/linsys/external/amd/amd_defaults.c +37 -0
  47. data/vendor/scs/linsys/external/amd/amd_defaults.o +0 -0
  48. data/vendor/scs/linsys/external/amd/amd_dump.c +179 -0
  49. data/vendor/scs/linsys/external/amd/amd_dump.o +0 -0
  50. data/vendor/scs/linsys/external/amd/amd_global.c +16 -0
  51. data/vendor/scs/linsys/external/amd/amd_global.o +0 -0
  52. data/vendor/scs/linsys/external/amd/amd_info.c +119 -0
  53. data/vendor/scs/linsys/external/amd/amd_info.o +0 -0
  54. data/vendor/scs/linsys/external/amd/amd_internal.h +304 -0
  55. data/vendor/scs/linsys/external/amd/amd_order.c +199 -0
  56. data/vendor/scs/linsys/external/amd/amd_order.o +0 -0
  57. data/vendor/scs/linsys/external/amd/amd_post_tree.c +120 -0
  58. data/vendor/scs/linsys/external/amd/amd_post_tree.o +0 -0
  59. data/vendor/scs/linsys/external/amd/amd_postorder.c +206 -0
  60. data/vendor/scs/linsys/external/amd/amd_postorder.o +0 -0
  61. data/vendor/scs/linsys/external/amd/amd_preprocess.c +118 -0
  62. data/vendor/scs/linsys/external/amd/amd_preprocess.o +0 -0
  63. data/vendor/scs/linsys/external/amd/amd_valid.c +92 -0
  64. data/vendor/scs/linsys/external/amd/amd_valid.o +0 -0
  65. data/vendor/scs/linsys/external/amd/changes +11 -0
  66. data/vendor/scs/linsys/external/qdldl/LICENSE +201 -0
  67. data/vendor/scs/linsys/external/qdldl/README.md +120 -0
  68. data/vendor/scs/linsys/external/qdldl/changes +4 -0
  69. data/vendor/scs/linsys/external/qdldl/qdldl.c +298 -0
  70. data/vendor/scs/linsys/external/qdldl/qdldl.h +177 -0
  71. data/vendor/scs/linsys/external/qdldl/qdldl.o +0 -0
  72. data/vendor/scs/linsys/external/qdldl/qdldl_types.h +21 -0
  73. data/vendor/scs/linsys/gpu/gpu.c +41 -0
  74. data/vendor/scs/linsys/gpu/gpu.h +85 -0
  75. data/vendor/scs/linsys/gpu/indirect/private.c +304 -0
  76. data/vendor/scs/linsys/gpu/indirect/private.h +36 -0
  77. data/vendor/scs/scs.mk +181 -0
  78. data/vendor/scs/src/aa.c +224 -0
  79. data/vendor/scs/src/aa.o +0 -0
  80. data/vendor/scs/src/cones.c +802 -0
  81. data/vendor/scs/src/cones.o +0 -0
  82. data/vendor/scs/src/ctrlc.c +77 -0
  83. data/vendor/scs/src/ctrlc.o +0 -0
  84. data/vendor/scs/src/linalg.c +84 -0
  85. data/vendor/scs/src/linalg.o +0 -0
  86. data/vendor/scs/src/normalize.c +93 -0
  87. data/vendor/scs/src/normalize.o +0 -0
  88. data/vendor/scs/src/rw.c +167 -0
  89. data/vendor/scs/src/rw.o +0 -0
  90. data/vendor/scs/src/scs.c +978 -0
  91. data/vendor/scs/src/scs.o +0 -0
  92. data/vendor/scs/src/scs_version.c +5 -0
  93. data/vendor/scs/src/scs_version.o +0 -0
  94. data/vendor/scs/src/util.c +196 -0
  95. data/vendor/scs/src/util.o +0 -0
  96. data/vendor/scs/test/data/small_random_socp +0 -0
  97. data/vendor/scs/test/minunit.h +13 -0
  98. data/vendor/scs/test/problem_utils.h +93 -0
  99. data/vendor/scs/test/problems/rob_gauss_cov_est.h +85 -0
  100. data/vendor/scs/test/problems/small_lp.h +50 -0
  101. data/vendor/scs/test/problems/small_random_socp.h +33 -0
  102. data/vendor/scs/test/random_socp_prob.c +171 -0
  103. data/vendor/scs/test/run_from_file.c +69 -0
  104. data/vendor/scs/test/run_tests +2 -0
  105. data/vendor/scs/test/run_tests.c +32 -0
  106. metadata +203 -0
@@ -0,0 +1,92 @@
1
+ /* ========================================================================= */
2
+ /* === AMD_valid =========================================================== */
3
+ /* ========================================================================= */
4
+
5
+ /* ------------------------------------------------------------------------- */
6
+ /* AMD, Copyright (c) Timothy A. Davis, */
7
+ /* Patrick R. Amestoy, and Iain S. Duff. See ../README.txt for License. */
8
+ /* email: DrTimothyAldenDavis@gmail.com */
9
+ /* ------------------------------------------------------------------------- */
10
+
11
+ /* Check if a column-form matrix is valid or not. The matrix A is
12
+ * n_row-by-n_col. The row indices of entries in column j are in
13
+ * Ai [Ap [j] ... Ap [j+1]-1]. Required conditions are:
14
+ *
15
+ * n_row >= 0
16
+ * n_col >= 0
17
+ * nz = Ap [n_col] >= 0 number of entries in the matrix
18
+ * Ap [0] == 0
19
+ * Ap [j] <= Ap [j+1] for all j in the range 0 to n_col.
20
+ * Ai [0 ... nz-1] must be in the range 0 to n_row-1.
21
+ *
22
+ * If any of the above conditions hold, AMD_INVALID is returned. If the
23
+ * following condition holds, AMD_OK_BUT_JUMBLED is returned (a warning,
24
+ * not an error):
25
+ *
26
+ * row indices in Ai [Ap [j] ... Ap [j+1]-1] are not sorted in ascending
27
+ * order, and/or duplicate entries exist.
28
+ *
29
+ * Otherwise, AMD_OK is returned.
30
+ *
31
+ * In v1.2 and earlier, this function returned TRUE if the matrix was valid
32
+ * (now returns AMD_OK), or FALSE otherwise (now returns AMD_INVALID or
33
+ * AMD_OK_BUT_JUMBLED).
34
+ */
35
+
36
+ #include "amd_internal.h"
37
+
38
+ GLOBAL Int AMD_valid
39
+ (
40
+ /* inputs, not modified on output: */
41
+ Int n_row, /* A is n_row-by-n_col */
42
+ Int n_col,
43
+ const Int Ap [ ], /* column pointers of A, of size n_col+1 */
44
+ const Int Ai [ ] /* row indices of A, of size nz = Ap [n_col] */
45
+ )
46
+ {
47
+ Int nz, j, p1, p2, ilast, i, p, result = AMD_OK ;
48
+
49
+ if (n_row < 0 || n_col < 0 || Ap == NULL || Ai == NULL)
50
+ {
51
+ return (AMD_INVALID) ;
52
+ }
53
+ nz = Ap [n_col] ;
54
+ if (Ap [0] != 0 || nz < 0)
55
+ {
56
+ /* column pointers must start at Ap [0] = 0, and Ap [n] must be >= 0 */
57
+ AMD_DEBUG0 (("column 0 pointer bad or nz < 0\n")) ;
58
+ return (AMD_INVALID) ;
59
+ }
60
+ for (j = 0 ; j < n_col ; j++)
61
+ {
62
+ p1 = Ap [j] ;
63
+ p2 = Ap [j+1] ;
64
+ AMD_DEBUG2 (("\nColumn: "ID" p1: "ID" p2: "ID"\n", j, p1, p2)) ;
65
+ if (p1 > p2)
66
+ {
67
+ /* column pointers must be ascending */
68
+ AMD_DEBUG0 (("column "ID" pointer bad\n", j)) ;
69
+ return (AMD_INVALID) ;
70
+ }
71
+ ilast = EMPTY ;
72
+ for (p = p1 ; p < p2 ; p++)
73
+ {
74
+ i = Ai [p] ;
75
+ AMD_DEBUG3 (("row: "ID"\n", i)) ;
76
+ if (i < 0 || i >= n_row)
77
+ {
78
+ /* row index out of range */
79
+ AMD_DEBUG0 (("index out of range, col "ID" row "ID"\n", j, i));
80
+ return (AMD_INVALID) ;
81
+ }
82
+ if (i <= ilast)
83
+ {
84
+ /* row index unsorted, or duplicate entry present */
85
+ AMD_DEBUG1 (("index unsorted/dupl col "ID" row "ID"\n", j, i));
86
+ result = AMD_OK_BUT_JUMBLED ;
87
+ }
88
+ ilast = i ;
89
+ }
90
+ }
91
+ return (result) ;
92
+ }
@@ -0,0 +1,11 @@
1
+ Flatten out all .c and .h to single dir.
2
+ All files: double -> scs_float.
3
+ git grep -l 'double' | xargs sed -i 's/double/scs_float/g'
4
+ SuiteSparse_config.h: add '#include "scs.h"'
5
+ add '#include "ctrlc.h"'
6
+ add '#define SuiteSparse_long scs_int'
7
+ disable timer #define NTIMER
8
+ SuiteSparse_config.c: replace *alloc and printf in 2 structs.
9
+ amd_internal.h: remove all refs to long version, int -> scs_int
10
+ amd_global.c: add typedef to rm warning
11
+ amd.h: int -> scs_int.h
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,120 @@
1
+ # QDLDL
2
+ A free LDL factorisation routine for quasi-definite linear systems: `Ax=b`
3
+
4
+ [![Build Status](https://travis-ci.org/oxfordcontrol/qdldl.svg?branch=master)](https://travis-ci.org/oxfordcontrol/qdldl)
5
+ [![Build status](https://ci.appveyor.com/api/projects/status/ns4br7v6y3i5stai/branch/master?svg=true)](https://ci.appveyor.com/project/bstellato/qdldl-8q1mv/branch/master)
6
+ [![Coverage Status](https://coveralls.io/repos/github/oxfordcontrol/qdldl/badge.svg)](https://coveralls.io/github/oxfordcontrol/qdldl)
7
+
8
+
9
+ ## Getting started
10
+ To start using QDLDL, first clone the repository
11
+
12
+ ```bash
13
+ git clone https://github.com/oxfordcontrol/qdldl.git
14
+ ```
15
+
16
+ ### Build
17
+
18
+ To build QDLDL, you need to install [cmake](https://cmake.org/) and run
19
+
20
+ ```bash
21
+ mkdir build
22
+ cd build
23
+ cmake ..
24
+ cmake --build .
25
+ ```
26
+
27
+ This will generate an `out/` folder with contents:
28
+
29
+ - `qdldl_example`: a **code example** from [`examples/c/example.c`](./examples/c/example.c)
30
+ - `libqdldl`: a static and a dynamic versions of the library.
31
+
32
+ You can include an addition option `-DUNITTESTS=ON` when calling `cmake`, which will result in an additional executable `qdldl_tester` being built in the `out/` folder to test QDLDL on a variety of problems, including those with rank deficient or otherwise ill-formatted inputs.
33
+
34
+ **N.B.** All files will have file extensions appropriate to your operating system.
35
+
36
+
37
+ ### Install/Uninstall
38
+
39
+ To install (uninstall) the libraries and headers you can simply run `make install` (`make uninstall`) after running the `cmake` command above.
40
+
41
+
42
+ ## Calling QDLDL
43
+
44
+ ### Main API
45
+
46
+ The QDLDL API consists of 5 functions documented in [`include/qdldl.h`](./include/qdldl.h).
47
+ For more details and a working example see [`examples/c/example.c`](./examples/c/example.c).
48
+
49
+ **N.B.** There is **no memory allocation** performed in these routines. The user is assumed to have the working vectors already allocated.
50
+
51
+ Here is a brief summary.
52
+
53
+ * `QDLDL_etree`: compute the elimination tree for the quasidefinite matrix factorization `A = LDL'`
54
+ * `QDLDL_factor`: return the factors `L`, `D` and `Dinv = 1./D`
55
+ * `QDLDL_solve`: solves the linear system `LDL'x = b`
56
+ * `QDLDL_Lsolve`: solves `Lx = b`
57
+ * `QDLDL_Ltsolve`: solves `L'x = b`
58
+
59
+ In the above function calls the matrices `A` and `L` are stored in compressed sparse column (CSC) format. The matrix `A` is assumed to be symmetric and only the upper triangular portion of A should be passed to the API. The factor `L` is lower triangular with implicit ones on the diagonal (i.e. the diagonal of L is not stored as part of the CSC formatted data.)
60
+
61
+ The matrices `D` and `Dinv` are both diagonal matrices, with the diagonal values stored in an array.
62
+
63
+ The matrix input `A` should be quasidefinite. The API provides some (non-comprehensive) error checking to protect against non-quasidefinite or non-upper triangular inputs.
64
+
65
+ ### Custom types for integer, floats and booleans
66
+ QDLDL uses its own internal types for integers, floats and booleans (`QDLDL_int, QDLDL_float, QDLDL_bool`. They can be specified using the cmake options:
67
+
68
+ - `DFLOAT` (default false): uses float numbers instead of doubles
69
+ - `DLONG` (default true): uses long integers for indexing (for large matrices)
70
+
71
+ The `QDLDL_bool` is internally defined as `unsigned char`.
72
+
73
+
74
+ ## Linking QDLDL
75
+
76
+ ### Basic Example
77
+ A basic example appears in [`examples/c/example.c`](./examples/c/example.c) and is compiled using cmake and the `CMakeLists.txt` file in the root folder.
78
+
79
+
80
+ ### Including in a cmake project
81
+
82
+ You can include QDLDL in a cmake project `foo` by adding the subdirectory as
83
+ ```
84
+ # Add project
85
+ add_subdirectory(qdldl)
86
+ ```
87
+
88
+ QDLDL can be linked using a static or dynamic linker
89
+ ```
90
+ # Link static library
91
+ target_link_libraries (foo qdldlstatic)
92
+
93
+ # Link shared library
94
+ target_link_libraries (foo qdldl)
95
+ ```
96
+ for dynamic linking the shared library should be available in your path.
97
+
98
+ There is also the option to include QDLDL as an object library in your project.
99
+ The current `CMakeLists.txt` file creates an object library called `qdldlobject`.
100
+ This can be added to your project by adding it after your sources.
101
+ For example, when creating a library `foo` you can add
102
+
103
+ ```
104
+ add_library(foo foo.c foo.h $<TARGET_OBJECTS:qdldlobject>)
105
+ ```
106
+ for more details see the [cmake documentation](https://cmake.org/cmake/help/latest/command/add_library.html#object-libraries).
107
+
108
+
109
+ ## The algorithm
110
+
111
+ The algorithm is an independent implementation of the elimination tree and factorisation procedures outlined in
112
+
113
+ > T. A Davis. [Algorithm 849: a concise sparse cholesky factorization package](https://dl.acm.org/citation.cfm?id=1114277). ACM Trans. Math. Softw., 31(4):587–591, 2005.
114
+
115
+
116
+ ## Credits
117
+
118
+ - [Paul Goulart](http://users.ox.ac.uk/~engs1373/): main development
119
+ - [Bartolomeo Stellato](https://stellato.io/): code refactoring and testing
120
+ - [Goran Banjac](http://control.ee.ethz.ch/~gbanjac/)
@@ -0,0 +1,4 @@
1
+ flatten into one dir
2
+ create qdldl_types.h from template file
3
+ add 'include "glbopts.h"' to qdldl_types.h
4
+ manually insert scs types into qdldl_types.h
@@ -0,0 +1,298 @@
1
+ #include "qdldl.h"
2
+ #include "ctrlc.h"
3
+
4
+ #define QDLDL_UNKNOWN (-1)
5
+ #define QDLDL_USED (1)
6
+ #define QDLDL_UNUSED (0)
7
+
8
+ // //DEBUG
9
+ // #include <stdio.h>
10
+ // void qdprint_arrayi(const QDLDL_int* data, QDLDL_int n,char* varName){
11
+
12
+ // QDLDL_int i;
13
+ // printf("%s = [",varName);
14
+ // for(i=0; i< n; i++){
15
+ // printf("%lli,",data[i]);
16
+ // }
17
+ // printf("]\n");
18
+
19
+ // }
20
+
21
+ // void qdprint_arrayf(const QDLDL_float* data, QDLDL_int n, char* varName){
22
+
23
+ // QDLDL_int i;
24
+ // printf("%s = [",varName);
25
+ // for(i=0; i< n; i++){
26
+ // printf("%.3g,",data[i]);
27
+ // }
28
+ // printf("]\n");
29
+
30
+ // }
31
+ // // END DEBUG
32
+
33
+ /* Compute the elimination tree for a quasidefinite matrix
34
+ in compressed sparse column form.
35
+ */
36
+
37
+ QDLDL_int QDLDL_etree(const QDLDL_int n,
38
+ const QDLDL_int* Ap,
39
+ const QDLDL_int* Ai,
40
+ QDLDL_int* work,
41
+ QDLDL_int* Lnz,
42
+ QDLDL_int* etree){
43
+
44
+ QDLDL_int sumLnz = 0;
45
+ QDLDL_int i,j,p;
46
+
47
+
48
+ for(i = 0; i < n; i++){
49
+ // zero out Lnz and work. Set all etree values to unknown
50
+ work[i] = 0;
51
+ Lnz[i] = 0;
52
+ etree[i] = QDLDL_UNKNOWN;
53
+
54
+ //Abort if A doesn't have at least one entry
55
+ //one entry in every column
56
+ if(Ap[i] == Ap[i+1]){
57
+ return -1;
58
+ }
59
+
60
+ }
61
+
62
+ for(j = 0; j < n; j++){
63
+ work[j] = j;
64
+ for(p = Ap[j]; p < Ap[j+1]; p++){
65
+ i = Ai[p];
66
+ if(i > j){return -1;}; //abort if entries on lower triangle
67
+ while(work[i] != j){
68
+ if(etree[i] == QDLDL_UNKNOWN){
69
+ etree[i] = j;
70
+ }
71
+ Lnz[i]++; //nonzeros in this column
72
+ work[i] = j;
73
+ i = etree[i];
74
+ }
75
+ }
76
+ }
77
+
78
+ //compute the total nonzeros in L. This much
79
+ //space is required to store Li and Lx
80
+ for(i = 0; i < n; i++){sumLnz += Lnz[i];}
81
+
82
+ return sumLnz;
83
+ }
84
+
85
+
86
+
87
+ QDLDL_int QDLDL_factor(const QDLDL_int n,
88
+ const QDLDL_int* Ap,
89
+ const QDLDL_int* Ai,
90
+ const QDLDL_float* Ax,
91
+ QDLDL_int* Lp,
92
+ QDLDL_int* Li,
93
+ QDLDL_float* Lx,
94
+ QDLDL_float* D,
95
+ QDLDL_float* Dinv,
96
+ const QDLDL_int* Lnz,
97
+ const QDLDL_int* etree,
98
+ QDLDL_bool* bwork,
99
+ QDLDL_int* iwork,
100
+ QDLDL_float* fwork){
101
+
102
+ QDLDL_int i,j,k,nnzY, bidx, cidx, nextIdx, nnzE, tmpIdx;
103
+ QDLDL_int *yIdx, *elimBuffer, *LNextSpaceInCol;
104
+ QDLDL_float *yVals;
105
+ QDLDL_float yVals_cidx;
106
+ QDLDL_bool *yMarkers;
107
+ QDLDL_int positiveValuesInD = 0;
108
+
109
+ //partition working memory into pieces
110
+ yMarkers = bwork;
111
+ yIdx = iwork;
112
+ elimBuffer = iwork + n;
113
+ LNextSpaceInCol = iwork + n*2;
114
+ yVals = fwork;
115
+
116
+
117
+ Lp[0] = 0; //first column starts at index zero
118
+
119
+ for(i = 0; i < n; i++){
120
+
121
+ //compute L column indices
122
+ Lp[i+1] = Lp[i] + Lnz[i]; //cumsum, total at the end
123
+
124
+ // set all Yidx to be 'unused' initially
125
+ //in each column of L, the next available space
126
+ //to start is just the first space in the column
127
+ yMarkers[i] = QDLDL_UNUSED;
128
+ yVals[i] = 0.0;
129
+ D[i] = 0.0;
130
+ LNextSpaceInCol[i] = Lp[i];
131
+ }
132
+
133
+ // First element of the diagonal D.
134
+ D[0] = Ax[0];
135
+ if(D[0] == 0.0){return -1;}
136
+ if(D[0] > 0.0){positiveValuesInD++;}
137
+ Dinv[0] = 1/D[0];
138
+
139
+ //Start from 1 here. The upper LH corner is trivially 0
140
+ //in L b/c we are only computing the subdiagonal elements
141
+ for(k = 1; k < n; k++){
142
+ if(scs_is_interrupted()) {
143
+ scs_printf("interrupt detected in factorization\n");
144
+ return -1;
145
+ }
146
+
147
+ //NB : For each k, we compute a solution to
148
+ //y = L(0:(k-1),0:k-1))\b, where b is the kth
149
+ //column of A that sits above the diagonal.
150
+ //The solution y is then the kth row of L,
151
+ //with an implied '1' at the diagonal entry.
152
+
153
+ //number of nonzeros in this row of L
154
+ nnzY = 0; //number of elements in this row
155
+
156
+ //This loop determines where nonzeros
157
+ //will go in the kth row of L, but doesn't
158
+ //compute the actual values
159
+ tmpIdx = Ap[k+1];
160
+
161
+ for(i = Ap[k]; i < tmpIdx; i++){
162
+
163
+ bidx = Ai[i]; // we are working on this element of b
164
+
165
+ //Initialize D[k] as the element of this column
166
+ //corresponding to the diagonal place. Don't use
167
+ //this element as part of the elimination step
168
+ //that computes the k^th row of L
169
+ if(bidx == k){
170
+ D[k] = Ax[i];
171
+ continue;
172
+ }
173
+
174
+ yVals[bidx] = Ax[i]; // initialise y(bidx) = b(bidx)
175
+
176
+ // use the forward elimination tree to figure
177
+ // out which elements must be eliminated after
178
+ // this element of b
179
+ nextIdx = bidx;
180
+
181
+ if(yMarkers[nextIdx] == QDLDL_UNUSED){ //this y term not already visited
182
+
183
+ yMarkers[nextIdx] = QDLDL_USED; //I touched this one
184
+ elimBuffer[0] = nextIdx; // It goes at the start of the current list
185
+ nnzE = 1; //length of unvisited elimination path from here
186
+
187
+ nextIdx = etree[bidx];
188
+
189
+ while(nextIdx != QDLDL_UNKNOWN && nextIdx < k){
190
+ if(yMarkers[nextIdx] == QDLDL_USED) break;
191
+
192
+ yMarkers[nextIdx] = QDLDL_USED; //I touched this one
193
+ elimBuffer[nnzE] = nextIdx; //It goes in the current list
194
+ nnzE++; //the list is one longer than before
195
+ nextIdx = etree[nextIdx]; //one step further along tree
196
+
197
+ } //end while
198
+
199
+ // now I put the buffered elimination list into
200
+ // my current ordering in reverse order
201
+ while(nnzE){
202
+ yIdx[nnzY++] = elimBuffer[--nnzE];
203
+ } //end while
204
+ } //end if
205
+
206
+ } //end for i
207
+
208
+ //This for loop places nonzeros values in the k^th row
209
+ for(i = (nnzY-1); i >=0; i--){
210
+
211
+ //which column are we working on?
212
+ cidx = yIdx[i];
213
+
214
+ // loop along the elements in this
215
+ // column of L and subtract to solve to y
216
+ tmpIdx = LNextSpaceInCol[cidx];
217
+ yVals_cidx = yVals[cidx];
218
+ for(j = Lp[cidx]; j < tmpIdx; j++){
219
+ yVals[Li[j]] -= Lx[j]*yVals_cidx;
220
+ }
221
+
222
+ //Now I have the cidx^th element of y = L\b.
223
+ //so compute the corresponding element of
224
+ //this row of L and put it into the right place
225
+ Li[tmpIdx] = k;
226
+ Lx[tmpIdx] = yVals_cidx *Dinv[cidx];
227
+
228
+ //D[k] -= yVals[cidx]*yVals[cidx]*Dinv[cidx];
229
+ D[k] -= yVals_cidx*Lx[tmpIdx];
230
+ LNextSpaceInCol[cidx]++;
231
+
232
+ //reset the yvalues and indices back to zero and QDLDL_UNUSED
233
+ //once I'm done with them
234
+ yVals[cidx] = 0.0;
235
+ yMarkers[cidx] = QDLDL_UNUSED;
236
+
237
+ } //end for i
238
+
239
+ //Maintain a count of the positive entries
240
+ //in D. If we hit a zero, we can't factor
241
+ //this matrix, so abort
242
+ if(D[k] == 0.0){return -1;}
243
+ if(D[k] > 0.0){positiveValuesInD++;}
244
+
245
+ //compute the inverse of the diagonal
246
+ Dinv[k]= 1/D[k];
247
+
248
+ } //end for k
249
+
250
+ return positiveValuesInD;
251
+
252
+ }
253
+
254
+ // Solves (L+I)x = b
255
+ void QDLDL_Lsolve(const QDLDL_int n,
256
+ const QDLDL_int* Lp,
257
+ const QDLDL_int* Li,
258
+ const QDLDL_float* Lx,
259
+ QDLDL_float* x){
260
+
261
+ QDLDL_int i,j;
262
+ for(i = 0; i < n; i++){
263
+ for(j = Lp[i]; j < Lp[i+1]; j++){
264
+ x[Li[j]] -= Lx[j]*x[i];
265
+ }
266
+ }
267
+ }
268
+
269
+ // Solves (L+I)'x = b
270
+ void QDLDL_Ltsolve(const QDLDL_int n,
271
+ const QDLDL_int* Lp,
272
+ const QDLDL_int* Li,
273
+ const QDLDL_float* Lx,
274
+ QDLDL_float* x){
275
+
276
+ QDLDL_int i,j;
277
+ for(i = n-1; i>=0; i--){
278
+ for(j = Lp[i]; j < Lp[i+1]; j++){
279
+ x[i] -= Lx[j]*x[Li[j]];
280
+ }
281
+ }
282
+ }
283
+
284
+ // Solves Ax = b where A has given LDL factors
285
+ void QDLDL_solve(const QDLDL_int n,
286
+ const QDLDL_int* Lp,
287
+ const QDLDL_int* Li,
288
+ const QDLDL_float* Lx,
289
+ const QDLDL_float* Dinv,
290
+ QDLDL_float* x){
291
+
292
+ QDLDL_int i;
293
+
294
+ QDLDL_Lsolve(n,Lp,Li,Lx,x);
295
+ for(i = 0; i < n; i++) x[i] *= Dinv[i];
296
+ QDLDL_Ltsolve(n,Lp,Li,Lx,x);
297
+
298
+ }