linSys.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 LINSYS_H_GUARD
#define LINSYS_H_GUARD

#ifdef __cplusplus
extern "C" {
#endif

    /* 
     * YOUR LINEAR SYSTEM SOLVER MUST IMPLEMENT THESE METHODS AND scs_private_data
     * STRUCT 
     */

    /* 
     * private data structs (that you define) containing any necessary data to solve
     * linear system, etc. 
     */

    /* 
     * this defines the matrix A, only the linear system solver interacts with this
     * struct 
     */

    typedef struct scs_a_data_matrix ScsAMatrix;

    typedef struct scs_private_data ScsPrivWorkspace;

    ScsPrivWorkspace *scs_init_priv(
            const ScsAMatrix *A,
            const ScsSettings *stgs);

    scs_int scs_solve_lin_sys(
            const ScsAMatrix *A,
            const ScsSettings *stgs,
            ScsPrivWorkspace *p,
            scs_float *b,
            const scs_float *s,
            scs_int iter);
    void scs_free_priv(ScsPrivWorkspace *p);

    void scs_accum_by_a_trans(
            const ScsAMatrix *A,
            ScsPrivWorkspace *p,
            const scs_float *x,
            scs_float *y);

    void scs_accum_by_a(
            const ScsAMatrix *A,
            ScsPrivWorkspace *p,
            const scs_float *x,
            scs_float *y);

    scs_int scs_validate_linsys(
            const ScsAMatrix *A);

    char *scs_get_linsys_method(
            const ScsAMatrix *A,
            const ScsSettings *stgs);

    char *scs_get_linsys_summary(
            ScsPrivWorkspace *p,
            const ScsInfo *info);

    /* Normalization routines, used if d->NORMALIZE is true */
    void scs_normalize_a(
            ScsAMatrix *A,
            const ScsSettings *stgs,
            const ScsCone *k,
            ScsScaling *scal);

    void scs_unnormalize_a(
            ScsAMatrix *A,
            const ScsSettings *stgs,
            const ScsScaling *scal);

    void scs_free_a_matrix(ScsAMatrix *A);
    
    scs_int scs_linsys_is_indirect(void);
    
    scs_int scs_linsys_total_cg_iters(ScsPrivWorkspace *priv);
    
    scs_float scs_linsys_total_solve_time_ms(ScsPrivWorkspace *priv);

#ifdef COPYAMATRIX

    scs_int scs_copy_a_matrix(
            ScsAMatrix **dstp,
            const ScsAMatrix *src);
#endif

#ifdef __cplusplus
}
#endif

#endif