cones.h

Go to the documentation of this file.

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2017 Pantelis Sopasakis (https://alphaville.github.io),
 *                    Krina Menounou (https://www.linkedin.com/in/krinamenounou), 
 *                    Panagiotis Patrinos (http://homes.esat.kuleuven.be/~ppatrino)
 * Copyright (c) 2012 Brendan O'Donoghue (bodonoghue85@gmail.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 */
#ifndef SCS_CONES_H_GUARD
#define SCS_CONES_H_GUARD

#ifdef __cplusplus
extern "C" {
#endif

#include "glbopts.h"
#include "scs_blas.h"

    /* NB: rows of data matrix A must be specified in this exact order */

    struct scs_cone {
        scs_int f;
        scs_int l;
        scs_int *RESTRICT q;
        scs_int qsize; 
        scs_int *RESTRICT s; 
        scs_int ssize; 
        scs_int ep; 
        scs_int ed; 
        scs_float * p; 
        scs_int psize; 
    };

    typedef struct scs_cone_work {
#ifdef LAPACK_LIB_FOUND
        /* workspace for eigenvector decompositions: */
        scs_float * RESTRICT Xs;
        scs_float * RESTRICT Z;
        scs_float * RESTRICT e;
        scs_float * RESTRICT work;
        blasint * RESTRICT iwork, lwork, liwork;
#endif
        scs_float total_cone_time;
    } ScsConeWork;

    scs_int scs_get_cone_boundaries(
            const ScsCone * RESTRICT k,
            scs_int ** RESTRICT boundaries);

    ScsConeWork *scs_init_conework(const ScsCone * RESTRICT k);

    char *scs_get_cone_header(const ScsCone *k);

    scs_int scs_validate_cones(
            const ScsData * RESTRICT d,
            const ScsCone * RESTRICT k);

    scs_int scs_project_dual_cone(
            scs_float * RESTRICT x,
            const ScsCone * RESTRICT k,
            ScsConeWork * RESTRICT c,
            const scs_float * RESTRICT warm_start,
            scs_int iter);

    void scs_finish_cone(
            ScsConeWork * RESTRICT coneWork);

    char *scs_get_cone_summary(
            const ScsInfo * RESTRICT info,
            ScsConeWork * RESTRICT c);

#ifdef __cplusplus
}
#endif
#endif