Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ default: make_dir $(OUT)/libscsdir.a $(OUT)/libscsindir.a $(OUT)/libscsdir.$(SHA
@echo " "
@echo "*************************************************************"
@echo "Successfully compiled SuperSCS (based on SCS) "
@echo "Find more at: https://github.com/kul-forbes/scs "
@echo "Find more at: https://github.com/kul-optec/superscs "
@echo "To test, type '$(OUT)/demo_direct' or '$(OUT)/demo_indirect',"
@echo "or '$(OUT)/demo_SOCP_indirect' to solve a random SOCP. "
@echo "To run the unit tests, type 'make run-test'. "
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
SuperSCS
====

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ef4a850c3a3b445f8130452b0edce2c6)](https://www.codacy.com/app/alphaville/scs?utm_source=github.com&utm_medium=referral&utm_content=kul-forbes/scs&utm_campaign=badger)
[![Build Status](https://travis-ci.org/kul-forbes/scs.svg?branch=master)](https://travis-ci.org/kul-optec/scs)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ef4a850c3a3b445f8130452b0edce2c6)](https://www.codacy.com/app/alphaville/scs?utm_source=github.com&utm_medium=referral&utm_content=kul-optec/superscs&utm_campaign=badger)
[![Build Status](https://travis-ci.org/kul-optec/superscs.svg?branch=master)](https://travis-ci.org/kul-optec/superscs)
[![Build status](https://ci.appveyor.com/api/projects/status/lsarbwklc8x93asy/branch/master?svg=true)](https://ci.appveyor.com/project/alphaville/scs/branch/master)
[![codecov](https://codecov.io/gh/kul-forbes/scs/branch/master/graph/badge.svg)](https://codecov.io/gh/kul-optec/scs)
[![Gitter](https://badges.gitter.im/kul-forbes/scs.svg)](https://gitter.im/kul-forbes/scs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![codecov](https://codecov.io/gh/kul-optec/superscs/branch/master/graph/badge.svg)](https://codecov.io/gh/kul-optec/superscs)
[![Gitter](https://badges.gitter.im/kul-optec/superscs.svg)](https://gitter.im/kul-optec/superscs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
<a href="https://kul-forbes.github.io/scs"><img src="https://img.shields.io/badge/Docs-RTFM-pink.svg" alt="RTFM" title="Documentation"></a>

Expand Down
2 changes: 1 addition & 1 deletion docs/coverage/src/scs_parser.c.gcov.html
Original file line number Diff line number Diff line change
Expand Up @@ -694,7 +694,7 @@
<span class="lineNum"> 624 </span><span class="lineCov"> 4 : metadata = scs_malloc(sizeof (*metadata));</span>
<span class="lineNum"> 625 </span><span class="lineCov"> 4 : if (metadata == SCS_NULL) return SCS_NULL;</span>
<span class="lineNum"> 626 </span><span class="lineCov"> 4 : strncpy(metadata-&gt;license,</span>
<span class="lineNum"> 627 </span> : &quot;https://github.com/kul-forbes/scs/blob/master/LICENSE.txt&quot;,
<span class="lineNum"> 627 </span> : &quot;https://github.com/kul-optec/superscs/blob/master/LICENSE.txt&quot;,
<span class="lineNum"> 628 </span> : SCS_METADATA_TEXT_SIZE);
<span class="lineNum"> 629 </span><span class="lineCov"> 4 : strncpy(metadata-&gt;problemName, problemName, SCS_METADATA_TEXT_SIZE);</span>
<span class="lineNum"> 630 </span><span class="lineCov"> 4 : snprintf(metadata-&gt;id, SCS_METADATA_TEXT_SIZE, &quot;http://superscs.org/problem/%s&quot;, problemName);</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/data/example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ meta:
date: '09-Apr-2018 19:41:52'
creator: 'SuperSCS'
yamlVersion: '1.2'
license: 'https://github.com/kul-forbes/scs/blob/master/LICENSE.txt'
license: 'https://github.com/kul-optec/superscs/blob/master/LICENSE.txt'
problem:
name: 'example-problem-1'
A:
Expand Down
4 changes: 2 additions & 2 deletions docs/data/merge-checklist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Code quality and compliance:
- [ ] Make sure there is adequate testing.
- [ ] Run `make COV=1 cov`; inspect the results
- [ ] Run `cppcheck`
- [ ] All unit tests pass on [travis CI](https://travis-ci.org/kul-forbes/scs)
- [ ] All unit tests pass on [travis CI](https://travis-ci.org/kul-optec/superscs)
- [ ] ... and on [Appveyor](https://ci.appveyor.com/project/alphaville/scs/history)
- [ ] Valgrind does not return any errors (`make run-tests-mem`)
- [ ] The profiler (`make PF=1 profile`) works
Expand All @@ -19,5 +19,5 @@ Code quality and compliance:
- [ ] Docker hub has been updated
- [ ] A pull request has preferably been created
- [ ] Changelog has been updated
- [ ] Make sure there are no important [issues](https://github.com/kul-forbes/scs/issues)
- [ ] Make sure there are no important [issues](https://github.com/kul-optec/superscs/issues)
- [ ] Check out [Trello](https://trello.com/b/YMcZoJN9/superscs)
14 changes: 7 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,17 +154,17 @@ <h1><a class="anchor" id="sec-documentation"></a>
</ol>
<h2><a class="anchor" id="sec-github-page"></a>
Download</h2>
<p>The source code of <a href="https://github.com/kul-forbes/scs">SuperSCS</a> is available on <a href="https://github.com/kul-forbes/scs">github</a>.</p>
<p>The source code of <a href="https://github.com/kul-optec/superscs">SuperSCS</a> is available on <a href="https://github.com/kul-optec/superscs">github</a>.</p>
<p>Check out the <a class="el" href="page_installation.html">installation guide</a>.</p>
<h2><a class="anchor" id="sec-verification"></a>
Verification</h2>
<p>Quality assurance:</p>
<ul>
<li><a href="https://github.com/kul-forbes/scs/tree/master/tests">unit tests</a> (<code>make run-test</code>)</li>
<li><a href="https://github.com/kul-optec/superscs/tree/master/tests">unit tests</a> (<code>make run-test</code>)</li>
<li><a href="http://valgrind.org">memory management tests</a> using valgrind</li>
<li><a href="https://travis-ci.org/kul-forbes/scs">continuous integration (Travis CI)</a> (Linux + Mac OSX)</li>
<li><a href="https://travis-ci.org/kul-optec/superscs">continuous integration (Travis CI)</a> (Linux + Mac OSX)</li>
<li><a href="https://ci.appveyor.com/project/alphaville/scs/branch/dev">continuous integration (Appveyor)</a> (Windows)</li>
<li><a href="https://codecov.io/gh/kul-forbes/scs">coverage reports</a> on Codecov</li>
<li><a href="https://codecov.io/gh/kul-optec/superscs">coverage reports</a> on Codecov</li>
<li><a href="https://www.codacy.com/app/alphaville/scs/dashboard">code quality reports</a> on codacy</li>
<li><a href="coverage/">lcov report</a> using <code>make cov COV=1</code></li>
</ul>
Expand All @@ -174,10 +174,10 @@ <h2><a class="anchor" id="sec-contributing-to-superscs"></a>
<p>Before contributing or filing an <a class="el" href="page_contributing.html#sec_git_issues">issue</a>, please read <a class="el" href="page_contributing.html">this guide</a>.</p>
<h2><a class="anchor" id="sec-license"></a>
License</h2>
<p>SuperSCS is licensed with an <a href="https://github.com/kul-forbes/scs/blob/master/LICENSE.txt">MIT license</a>.</p>
<p>SuperSCS is licensed with an <a href="https://github.com/kul-optec/superscs/blob/master/LICENSE.txt">MIT license</a>.</p>
<p>The MIT license is a short and simple permissive license with conditions only requiring preservation of copyright and license notices.</p>
<p>Licensed works, modifications, and larger works may be distributed under different terms and without source code.</p>
<p>You only need to keep <a href="https://github.com/kul-forbes/scs/blob/master/LICENSE.txt">LICENSE.txt</a> and, if you redistribute the source code, the copyright notices therein.</p>
<p>You only need to keep <a href="https://github.com/kul-optec/superscs/blob/master/LICENSE.txt">LICENSE.txt</a> and, if you redistribute the source code, the copyright notices therein.</p>
<h2><a class="anchor" id="sec-question"></a>
Do you have a question?</h2>
<p>Feel free to reach us on Gitter.</p>
Expand All @@ -193,7 +193,7 @@ <h2><a class="anchor" id="sec-question"></a>

<script>
((window.gitter = {}).chat = {}).options = {
room: 'kul-forbes/scs', //own room name
room: 'kul-optec/superscs', //own room name
activationElement: false
};
</script>
Expand Down
12 changes: 6 additions & 6 deletions docs/page_benchmark_results.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ <h2><a class="anchor" id="benchmark-parameters"></a>
<p>In Broyden's method we deactivated the K0 steps.</p>
<h2><a class="anchor" id="benchmarks-lasso"></a>
LASSO problems</h2>
<p><a href="https://github.com/kul-forbes/scs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_lasso.m">1152 lasso problems</a></p>
<p><a href="https://github.com/kul-optec/superscs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_lasso.m">1152 lasso problems</a></p>
<div> <table border="0">
<tr>
<td style="padding:1px"><div class="image">
Expand All @@ -173,7 +173,7 @@ <h2><a class="anchor" id="benchmarks-lasso"></a>
</table>
</div><h2><a class="anchor" id="benchmarks-pca1"></a>
Regularized PCA</h2>
<p><a href="https://github.com/kul-forbes/scs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_pca.m">288 regularized PCA problems</a></p>
<p><a href="https://github.com/kul-optec/superscs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_pca.m">288 regularized PCA problems</a></p>
<div> <table border="0">
<tr>
<td style="padding:1px"><div class="image">
Expand All @@ -189,7 +189,7 @@ <h2><a class="anchor" id="benchmarks-lasso"></a>
</table>
</div><h2><a class="anchor" id="benchmarks-logreg"></a>
Logistic regression problems</h2>
<p><a href="https://github.com/kul-forbes/scs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_logreg.m">288 logistic regression problems</a></p>
<p><a href="https://github.com/kul-optec/superscs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_logreg.m">288 logistic regression problems</a></p>
<div> <table border="0">
<tr>
<td style="padding:1px"><div class="image">
Expand All @@ -216,7 +216,7 @@ <h2><a class="anchor" id="benchmarks-lasso"></a>
</table>
</div><h2><a class="anchor" id="benchmarks-sdp2"></a>
Semidefinite programming</h2>
<p><a href="https://github.com/kul-forbes/scs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_sdp2.m">48 SDP problems</a></p>
<p><a href="https://github.com/kul-optec/superscs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_sdp2.m">48 SDP problems</a></p>
<div> <table border="0">
<tr>
<td style="padding:1px"><div class="image">
Expand All @@ -243,7 +243,7 @@ <h2><a class="anchor" id="benchmarks-lasso"></a>
</table>
</div><h2><a class="anchor" id="benchmarks-sdp2b"></a>
Ill-conditioned SDPs</h2>
<p><a href="https://github.com/kul-forbes/scs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_sdp2b.m">48 ill-conditioned SDP problems</a></p>
<p><a href="https://github.com/kul-optec/superscs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_sdp2b.m">48 ill-conditioned SDP problems</a></p>
<div> <table border="0">
<tr>
<td style="padding:1px"><div class="image">
Expand All @@ -270,7 +270,7 @@ <h2><a class="anchor" id="benchmarks-lasso"></a>
</table>
</div><h2><a class="anchor" id="benchmarks-normcon"></a>
Norm-constrained norm minimization</h2>
<p><a href="https://github.com/kul-forbes/scs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_normcon.m">256 norm-constrained problems</a></p>
<p><a href="https://github.com/kul-optec/superscs/blob/master/tests/profiling_matlab/profile_runners/profile_runner_normcon.m">256 norm-constrained problems</a></p>
<div> <table border="0">
<tr>
<td style="padding:1px"><div class="image">
Expand Down
2 changes: 1 addition & 1 deletion docs/page_benchmarks.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
<div class="textblock"><p>In what follows we give a few code snippets in MATLAB and compare SuperSCS with SCS.</p>
<p>This is a preliminary study to show that SuperSCS outperforms SCS, but a more thorough analysis is necessary.</p>
<p>In what follows we compare the two algorithms using five different types of problems: (i) a LASSO-like problem ( \(\ell_1\)-regularized least squares), (ii) a semidefinite program (SDP) and, in particular, a minimum-norm problem and an LMI-constrained problem, (iii) a logistic regression problem, (iv) a minimum \(p\)-norm problem, (v) a 2-norm-constrained minimum-norm problem and, last , (vi) a matrix completion problem involving the nuclear norm.</p>
<dl class="section note"><dt>Note</dt><dd>The following benchmarks are available in <a href="https://github.com/kul-forbes/scs/tree/master/tests/matlab">/tests/matlab/</a>.</dd>
<dl class="section note"><dt>Note</dt><dd>The following benchmarks are available in <a href="https://github.com/kul-optec/superscs/tree/master/tests/matlab">/tests/matlab/</a>.</dd>
<dd>
Reported runtimes were recorded on an Intel® Core™ i5-6200U CPU @ 2.30GHz × 4 machine with 11.6 GiB RAM running 64-bit Ubuntu 14.04.</dd>
<dd>
Expand Down
14 changes: 7 additions & 7 deletions docs/page_contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ <h2><a class="anchor" id="sec_style_documentation"></a>
</div>
<div class="fragment"><div class="line"><a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> scs_function(<a class="code" href="structscs__data.html">ScsData</a> * data, <a class="code" href="structscs__cone.html">ScsCone</a> * cone);</div>
</div><!-- fragment --><p>Installation instructions, mathematical documentation and other non-API documentation should not be part of function/variable documentation.</p>
<p>Instead, you should contribute to an existing page in <a href="https://github.com/kul-forbes/scs/tree/master/pages">pages/</a>.</p>
<p>Instead, you should contribute to an existing page in <a href="https://github.com/kul-optec/superscs/tree/master/pages">pages/</a>.</p>
<h2><a class="anchor" id="sec_unit_testing"></a>
Unit testing in C</h2>
<p>Unit tests are supported and executed by a simple in-house framework.</p>
Expand Down Expand Up @@ -266,14 +266,14 @@ <h3><a class="anchor" id="sec_issues_code_of_conduct"></a>

<script>
((window.gitter = {}).chat = {}).options = {
room: 'kul-forbes/scs', //own room name
room: 'kul-optec/superscs', //own room name
activationElement: false
};
</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
<h3><a class="anchor" id="sec_issues_report"></a>
Reporting an issue</h3>
<p>You may report your issue using the project's <a href="https://github.com/kul-forbes/scs/issues">issue tracker on github</a></p>
<p>You may report your issue using the project's <a href="https://github.com/kul-optec/superscs/issues">issue tracker on github</a></p>
<p>In your issue report, please include the following information:</p>
<ul>
<li><b>explanatory title</b>: a clear title</li>
Expand Down Expand Up @@ -329,7 +329,7 @@ <h2><a class="anchor" id="sec_git_commiting"></a>
</ul>
<h2><a class="anchor" id="sec_git_contributing"></a>
Contributing to SuperSCS</h2>
<p>In order to contribute and actively participate in the development of SuperSCS, you first need to <a href="https://github.com/kul-forbes/scs/fork">fork</a> the repository on github:</p>
<p>In order to contribute and actively participate in the development of SuperSCS, you first need to <a href="https://github.com/kul-optec/superscs/fork">fork</a> the repository on github:</p>

<iframe
src="https://ghbtns.com/github-btn.html?user=kul-forbes&repo=scs&type=fork&count=true&size=large"
Expand Down Expand Up @@ -358,7 +358,7 @@ <h2><a class="anchor" id="sec_git_merging_master"></a>
<li> <input type="checkbox"> New image uploaded on Docker Hub</li>
<li> <input type="checkbox"> A pull request has preferably been created</li>
<li> <input type="checkbox"> Changelog has been updated</li>
<li> <input type="checkbox"> Make sure there are no important <a href="https://github.com/kul-forbes/scs/issues">issues</a></li>
<li> <input type="checkbox"> Make sure there are no important <a href="https://github.com/kul-optec/superscs/issues">issues</a></li>
<li> <input type="checkbox"> Check out <a href="https://trello.com/b/YMcZoJN9/superscs">Trello</a></li>
</ul>
<p>After the pull request has been merged:</p>
Expand Down Expand Up @@ -397,7 +397,7 @@ <h3><a class="anchor" id="sec_performing_benchmarks_matlab_runners"></a>
<p>These mat files are not put under version control.</p>
<p>The third argument is a structure with runner configuration parameters.</p>
<p>These typically are ranges of the problem parameters to be tested, number of repetitions of each run and more.</p>
<p>Profile runners store some general statistics in the CSV file <a href="https://github.com/kul-forbes/scs/blob/master/tests/profiling_matlab/profile_results/register.csv">register.csv</a> which can be used for look-up purposes.</p>
<p>Profile runners store some general statistics in the CSV file <a href="https://github.com/kul-optec/superscs/blob/master/tests/profiling_matlab/profile_results/register.csv">register.csv</a> which can be used for look-up purposes.</p>
<h3><a class="anchor" id="sec_performing_benchmarks_matlab_experimenters"></a>
Experimenters</h3>
<p>Lastly, we have the <em>experimenters</em>. These are stored in <code>experimenters/</code>.</p>
Expand All @@ -413,7 +413,7 @@ <h2><a class="anchor" id="sec_docker_make"></a>
Making a Docker image</h2>
<p>To build a new docker image, run the following command from within the base directory of SuperSCS:</p>
<div class="fragment"><div class="line">docker image build -t kulforbes/superscs:v{version-name} .</div>
</div><!-- fragment --><p>The docker configuration is given in <a href="https://github.com/kul-forbes/scs/blob/master/Dockerfile">Dockerfile</a>. </p>
</div><!-- fragment --><p>The docker configuration is given in <a href="https://github.com/kul-optec/superscs/blob/master/Dockerfile">Dockerfile</a>. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
2 changes: 1 addition & 1 deletion docs/page_cvx_examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
<div class="textblock"><p>In what follows we give a few code snippets in MATLAB and compare SuperSCS with SCS.</p>
<p>This is a preliminary study to show that SuperSCS outperforms SCS, but a more thorough analysis is necessary.</p>
<p>In what follows we compare the two algorithms using five different types of problems: (i) a LASSO problem ( \(\ell_1\)-regularized least squares), (ii) a semidefinite program (SDP) and, in particular, a minimum-norm problem and an LMI-constrained problem, (iii) a logistic regression problem, (iv) a minimum \(p\)-norm problem, (v) a 2-norm-constrained minimum-norm problem and, last , (vi) a matrix completion problem involving the nuclear norm.</p>
<dl class="section note"><dt>Note</dt><dd>The following benchmarks are available in <a href="https://github.com/kul-forbes/scs/tree/master/tests/matlab">/tests/matlab/</a>.</dd>
<dl class="section note"><dt>Note</dt><dd>The following benchmarks are available in <a href="https://github.com/kul-optec/superscs/tree/master/tests/matlab">/tests/matlab/</a>.</dd>
<dd>
Reported runtimes were recorded on an Intel® Core™ i5-6200U CPU @ 2.30GHz × 4 machine with 11.6 GiB RAM running 64-bit Ubuntu 14.04.</dd>
<dd>
Expand Down
Loading