add comment

cvxgrp · Jan 11, 2022 · 073fb90 · 073fb90
1 parent fc8ebcf
commit 073fb90
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/include/scs.h b/include/scs.h
@@ -137,7 +137,10 @@ typedef struct {
 
 /** Contains primal-dual solution arrays or a certificate of infeasibility.
  *  Check the exit flag to determine whether this contains a solution or a
- *  certificate. */
+ *  certificate. If when passed into SCS the members `x`, `y`, `s` are
+ *  NULL then SCS will allocate memory for them which should be managed
+ *  by the user to prevent memory leaks.
+ */
 typedef struct {
   /** Primal variable. */
   scs_float *x;