util.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 UTIL_H_GUARD
#define UTIL_H_GUARD

#ifdef __cplusplus
extern "C" {
#endif
    
#if !(defined _WIN32 || defined _WIN64 || defined _WINDLL || defined __APPLE__)   
#ifdef _POSIX_C_SOURCE
#undef _POSIX_C_SOURCE
#endif
#define _POSIX_C_SOURCE 200112L
#endif

#include <stdlib.h>
#include <stdarg.h>
#include "scs.h"

    /* timing code courtesy of A. Domahidi */
#if (defined NOTIMER)
    typedef void *ScsTimer;
#elif(defined _WIN32 || defined _WIN64 || defined _WINDLL)
    /* Use Windows QueryPerformanceCounter for timing */
#include <windows.h>

    struct scs_timer {
        LARGE_INTEGER tic;
        LARGE_INTEGER toc;
        LARGE_INTEGER freq;
    };

#elif(defined __APPLE__)
    /* Use MAC OSX mach_time for timing */
#include <mach/mach_time.h>

    struct scs_timer {
        uint64_t tic;
        uint64_t toc;
        mach_timebase_info_data_t tinfo;
    };

#else

#include <sys/time.h> /* Use POSIX clock_gettime() for timing on other machines */
#include <time.h>

    struct scs_timer {
        struct timespec tic;
        struct timespec toc;
    };


#endif

    typedef struct scs_timer ScsTimer;

    /* these all return milli-seconds */

    void scs_tic(ScsTimer *timer);
    scs_float scs_toc(ScsTimer *timer);
    scs_float scs_strtoc(char *str, ScsTimer *timer);
    scs_float scs_toc_quiet(ScsTimer *timer);

    void scs_print_cone_data(const ScsCone * RESTRICT cone);
    void scs_print_data(const ScsData *data);
    void scs_print_work(const ScsWork *work);

    void scs_print_array(
            const scs_float * RESTRICT arr,
            scs_int n,
            const char *RESTRICT name);

    void scs_set_default_settings(ScsData * RESTRICT data);

    void scs_set_restarted_broyden_settings(ScsData * RESTRICT data, scs_int broyden_memory);

    void scs_set_anderson_settings(ScsData * RESTRICT data, scs_int anderson_memory);

    void scs_set_tolerance(ScsData * RESTRICT data, scs_float tolerance);
    
    void scs_set_memory(ScsData * RESTRICT data, scs_int memory);

    void scs_free_sol(ScsSolution * RESTRICT sol);
    
    void scs_free_data(ScsData *RESTRICT data);
    
    void scs_free_cone(ScsCone *RESTRICT cone);
    void scs_free_data_cone(ScsData * RESTRICT d, ScsCone * RESTRICT k);
    void scs_free_info(ScsInfo * RESTRICT info);

    int scs_special_print(scs_int print_mode,
            FILE * RESTRICT __stream,
            const char *RESTRICT __format, ...);

#ifdef __cplusplus
}
#endif
#endif