Skip to content

Commit

Permalink
📝 updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@alphaville
alphaville committed Apr 21, 2018
1 parent ec8414f commit 8502a16
Show file tree
Hide file tree
Showing 197 changed files with 16,087 additions and 5,137 deletions.
25 changes: 19 additions & 6 deletions docs/amatrix_8h.html
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="description" content="SuperSCS: Fast and Accurate Conic Programming"/>
<meta name="keywords" content="Optimization, Conic Programming, Conic Problems, Cone Programs"/>
<meta name="distribution" content="Global"/>
<meta name="author" content="Pantelis Sopasakis"/>
<meta name="robots" content="index,follow"/>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>SuperSCS: linsys/amatrix.h File Reference</title>
<title>SuperSCS: SuperSCS: Fast &amp; Accurate conic programming</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand All @@ -21,15 +24,25 @@
</script><script src="https://cdn.rawgit.com/mathjax/MathJax/2.7.1/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="dox_extra.css" rel="stylesheet" type="text/css"/>
<!-- Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117903175-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-117903175-1');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">SuperSCS
&#160;<span id="projectnumber">1.3.2</span>
</div>
</td>
</tr>
Expand Down Expand Up @@ -102,14 +115,14 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a___d_a_t_a___m_a_t_r_i_x.html">A_DATA_MATRIX</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sparse matrix A of the conic optimization problem. <a href="struct_a___d_a_t_a___m_a_t_r_i_x.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structscs__a__data__matrix.html">scs_a_data_matrix</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The sparse matrix A of the conic optimization problem. <a href="structscs__a__data__matrix.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 13 2018 15:27:01 for SuperSCS by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Apr 21 2018 11:25:45 for SuperSCS by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
61 changes: 37 additions & 24 deletions docs/amatrix_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="description" content="SuperSCS: Fast and Accurate Conic Programming"/>
<meta name="keywords" content="Optimization, Conic Programming, Conic Problems, Cone Programs"/>
<meta name="distribution" content="Global"/>
<meta name="author" content="Pantelis Sopasakis"/>
<meta name="robots" content="index,follow"/>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>SuperSCS: linsys/amatrix.h Source File</title>
<title>SuperSCS: SuperSCS: Fast &amp; Accurate conic programming</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand All @@ -21,15 +24,25 @@
</script><script src="https://cdn.rawgit.com/mathjax/MathJax/2.7.1/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="dox_extra.css" rel="stylesheet" type="text/css"/>
<!-- Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-117903175-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-117903175-1');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">SuperSCS
&#160;<span id="projectnumber">1.3.2</span>
</div>
</td>
</tr>
Expand Down Expand Up @@ -104,31 +117,31 @@
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">/* this struct defines the data matrix A */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="struct_a___d_a_t_a___m_a_t_r_i_x.html"> 17</a></span>&#160;<span class="keyword">struct </span><a class="code" href="struct_a___d_a_t_a___m_a_t_r_i_x.html">A_DATA_MATRIX</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="structscs__a__data__matrix.html"> 17</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structscs__a__data__matrix.html">scs_a_data_matrix</a> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">/* A is supplied in column compressed format */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a6ddc07d9e8387207c2bfa3fcac466d80"> 19</a></span>&#160; <a class="code" href="glbopts_8h.html#ad37836e6404bb2c3ae8adcc6290699b9">scs_float</a> *<a class="code" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a6ddc07d9e8387207c2bfa3fcac466d80">x</a>; <span class="comment">/* A values, size: NNZ A */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a1f7dbbbbd21533a7effe950c175e31e1"> 25</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> *<a class="code" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a1f7dbbbbd21533a7effe950c175e31e1">i</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#aa341eac00e906fabba371f34ce8f1e3c"> 31</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> *<a class="code" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#aa341eac00e906fabba371f34ce8f1e3c">p</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#abb8d3ac9f1eb0f06ce7c424c82d5f507"> 35</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> <a class="code" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#abb8d3ac9f1eb0f06ce7c424c82d5f507">m</a>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a4aa7f0765711dc019816ea1b84280d82"> 39</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> <a class="code" href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a4aa7f0765711dc019816ea1b84280d82">n</a>; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;};</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor"></span>}</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="struct_a___d_a_t_a___m_a_t_r_i_x_html_abb8d3ac9f1eb0f06ce7c424c82d5f507"><div class="ttname"><a href="struct_a___d_a_t_a___m_a_t_r_i_x.html#abb8d3ac9f1eb0f06ce7c424c82d5f507">A_DATA_MATRIX::m</a></div><div class="ttdeci">scs_int m</div><div class="ttdoc">Number of rows ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:35</div></div>
<div class="ttc" id="struct_a___d_a_t_a___m_a_t_r_i_x_html_a4aa7f0765711dc019816ea1b84280d82"><div class="ttname"><a href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a4aa7f0765711dc019816ea1b84280d82">A_DATA_MATRIX::n</a></div><div class="ttdeci">scs_int n</div><div class="ttdoc">Number of columns ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:39</div></div>
<div class="ttc" id="struct_a___d_a_t_a___m_a_t_r_i_x_html_a1f7dbbbbd21533a7effe950c175e31e1"><div class="ttname"><a href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a1f7dbbbbd21533a7effe950c175e31e1">A_DATA_MATRIX::i</a></div><div class="ttdeci">scs_int * i</div><div class="ttdoc">The row-index of the matrix ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:25</div></div>
<div class="ttc" id="struct_a___d_a_t_a___m_a_t_r_i_x_html_a6ddc07d9e8387207c2bfa3fcac466d80"><div class="ttname"><a href="struct_a___d_a_t_a___m_a_t_r_i_x.html#a6ddc07d9e8387207c2bfa3fcac466d80">A_DATA_MATRIX::x</a></div><div class="ttdeci">scs_float * x</div><div class="ttdef"><b>Definition:</b> amatrix.h:19</div></div>
<div class="ttc" id="glbopts_8h_html_a23c48a83ce0c58783595ad45ffcaf76b"><div class="ttname"><a href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a></div><div class="ttdeci">int scs_int</div><div class="ttdef"><b>Definition:</b> glbopts.h:65</div></div>
<div class="ttc" id="struct_a___d_a_t_a___m_a_t_r_i_x_html"><div class="ttname"><a href="struct_a___d_a_t_a___m_a_t_r_i_x.html">A_DATA_MATRIX</a></div><div class="ttdoc">The sparse matrix A of the conic optimization problem. </div><div class="ttdef"><b>Definition:</b> amatrix.h:17</div></div>
<div class="ttc" id="struct_a___d_a_t_a___m_a_t_r_i_x_html_aa341eac00e906fabba371f34ce8f1e3c"><div class="ttname"><a href="struct_a___d_a_t_a___m_a_t_r_i_x.html#aa341eac00e906fabba371f34ce8f1e3c">A_DATA_MATRIX::p</a></div><div class="ttdeci">scs_int * p</div><div class="ttdoc">Array of column pointers of A in CSC format ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:31</div></div>
<div class="ttc" id="glbopts_8h_html_ad37836e6404bb2c3ae8adcc6290699b9"><div class="ttname"><a href="glbopts_8h.html#ad37836e6404bb2c3ae8adcc6290699b9">scs_float</a></div><div class="ttdeci">double scs_float</div><div class="ttdef"><b>Definition:</b> glbopts.h:70</div></div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structscs__a__data__matrix.html#a6ddc07d9e8387207c2bfa3fcac466d80"> 22</a></span>&#160; <a class="code" href="glbopts_8h.html#ad37836e6404bb2c3ae8adcc6290699b9">scs_float</a> *<a class="code" href="structscs__a__data__matrix.html#a6ddc07d9e8387207c2bfa3fcac466d80">x</a>; <span class="comment">/* A values, size: NNZ A */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structscs__a__data__matrix.html#a1f7dbbbbd21533a7effe950c175e31e1"> 28</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> *<a class="code" href="structscs__a__data__matrix.html#a1f7dbbbbd21533a7effe950c175e31e1">i</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structscs__a__data__matrix.html#aa341eac00e906fabba371f34ce8f1e3c"> 36</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> *<a class="code" href="structscs__a__data__matrix.html#aa341eac00e906fabba371f34ce8f1e3c">p</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structscs__a__data__matrix.html#abb8d3ac9f1eb0f06ce7c424c82d5f507"> 40</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> <a class="code" href="structscs__a__data__matrix.html#abb8d3ac9f1eb0f06ce7c424c82d5f507">m</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structscs__a__data__matrix.html#a4aa7f0765711dc019816ea1b84280d82"> 44</a></span>&#160; <a class="code" href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a> <a class="code" href="structscs__a__data__matrix.html#a4aa7f0765711dc019816ea1b84280d82">n</a>; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;};</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"></span>}</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="structscs__a__data__matrix_html_a1f7dbbbbd21533a7effe950c175e31e1"><div class="ttname"><a href="structscs__a__data__matrix.html#a1f7dbbbbd21533a7effe950c175e31e1">scs_a_data_matrix::i</a></div><div class="ttdeci">scs_int * i</div><div class="ttdoc">The row-index of the matrix ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:28</div></div>
<div class="ttc" id="structscs__a__data__matrix_html_a6ddc07d9e8387207c2bfa3fcac466d80"><div class="ttname"><a href="structscs__a__data__matrix.html#a6ddc07d9e8387207c2bfa3fcac466d80">scs_a_data_matrix::x</a></div><div class="ttdeci">scs_float * x</div><div class="ttdoc">Values of A. </div><div class="ttdef"><b>Definition:</b> amatrix.h:22</div></div>
<div class="ttc" id="structscs__a__data__matrix_html"><div class="ttname"><a href="structscs__a__data__matrix.html">scs_a_data_matrix</a></div><div class="ttdoc">The sparse matrix A of the conic optimization problem. </div><div class="ttdef"><b>Definition:</b> amatrix.h:17</div></div>
<div class="ttc" id="structscs__a__data__matrix_html_aa341eac00e906fabba371f34ce8f1e3c"><div class="ttname"><a href="structscs__a__data__matrix.html#aa341eac00e906fabba371f34ce8f1e3c">scs_a_data_matrix::p</a></div><div class="ttdeci">scs_int * p</div><div class="ttdoc">Array of column pointers of A in CSC format ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:36</div></div>
<div class="ttc" id="glbopts_8h_html_a23c48a83ce0c58783595ad45ffcaf76b"><div class="ttname"><a href="glbopts_8h.html#a23c48a83ce0c58783595ad45ffcaf76b">scs_int</a></div><div class="ttdeci">int scs_int</div><div class="ttdef"><b>Definition:</b> glbopts.h:92</div></div>
<div class="ttc" id="structscs__a__data__matrix_html_a4aa7f0765711dc019816ea1b84280d82"><div class="ttname"><a href="structscs__a__data__matrix.html#a4aa7f0765711dc019816ea1b84280d82">scs_a_data_matrix::n</a></div><div class="ttdeci">scs_int n</div><div class="ttdoc">Number of columns ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:44</div></div>
<div class="ttc" id="structscs__a__data__matrix_html_abb8d3ac9f1eb0f06ce7c424c82d5f507"><div class="ttname"><a href="structscs__a__data__matrix.html#abb8d3ac9f1eb0f06ce7c424c82d5f507">scs_a_data_matrix::m</a></div><div class="ttdeci">scs_int m</div><div class="ttdoc">Number of rows ( ). </div><div class="ttdef"><b>Definition:</b> amatrix.h:40</div></div>
<div class="ttc" id="glbopts_8h_html_ad37836e6404bb2c3ae8adcc6290699b9"><div class="ttname"><a href="glbopts_8h.html#ad37836e6404bb2c3ae8adcc6290699b9">scs_float</a></div><div class="ttdeci">double scs_float</div><div class="ttdef"><b>Definition:</b> glbopts.h:96</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 13 2018 15:27:01 for SuperSCS by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Apr 21 2018 11:25:45 for SuperSCS by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
Expand Down
Loading

0 comments on commit 8502a16

Please sign in to comment.