sdpi.h

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                           */
/* This file is part of SCIPSDP - a solving framework for mixed-integer      */
/* semidefinite programs based on SCIP.                                      */
/*                                                                           */
/* Copyright (C) 2011-2013 Discrete Optimization, TU Darmstadt               */
/*                         EDOM, FAU Erlangen-Nürnberg                       */
/*               2014-2021 Discrete Optimization, TU Darmstadt               */
/*                                                                           */
/*                                                                           */
/* This program is free software; you can redistribute it and/or             */
/* modify it under the terms of the GNU Lesser General Public License        */
/* as published by the Free Software Foundation; either version 3            */
/* of the License, or (at your option) any later version.                    */
/*                                                                           */
/* This program is distributed in the hope that it will be useful,           */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of            */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             */
/* GNU Lesser General Public License for more details.                       */
/*                                                                           */
/* You should have received a copy of the GNU Lesser General Public License  */
/* along with this program; if not, write to the Free Software               */
/* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.*/
/*                                                                           */
/*                                                                           */
/* Based on SCIP - Solving Constraint Integer Programs                       */
/* Copyright (C) 2002-2021 Zuse Institute Berlin                             */
/* SCIP is distributed under the terms of the SCIP Academic Licence,         */
/* see file COPYING in the SCIP distribution.                                */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/

#ifndef __SCIP_SDPI_H__
#define __SCIP_SDPI_H__


#include "scip/def.h"
#include "blockmemshell/memory.h"
#include "scip/type_retcode.h"
#include "sdpi/type_sdpi.h"

#ifdef __cplusplus
extern "C" {
#endif

/*
 * Miscellaneous Methods
 */

SCIP_EXPORT
const char* SCIPsdpiGetSolverName(
   void
   );

SCIP_EXPORT
const char* SCIPsdpiGetSolverDesc(
   void
   );

SCIP_EXPORT
void* SCIPsdpiGetSolverPointer(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
int SCIPsdpiGetDefaultSdpiSolverNpenaltyIncreases(
   void
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiDoesWarmstartNeedPrimal(
   void
   );

/*
 * SDPI Creation and Destruction Methods
 */

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiCreate(
   SCIP_SDPI**           sdpi,               
   SCIP_MESSAGEHDLR*     messagehdlr,        
   BMS_BLKMEM*           blkmem,             
   BMS_BUFMEM*           bufmem              
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiFree(
   SCIP_SDPI**           sdpi                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiClone(
   SCIP_SDPI*            oldsdpi,            
   SCIP_SDPI*            newsdpi             
   );

/*
 * Modification Methods
 */

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiLoadSDP(
   SCIP_SDPI*            sdpi,               
   int                   nvars,              
   SCIP_Real*            obj,                
   SCIP_Real*            lb,                 
   SCIP_Real*            ub,                 
   int                   nsdpblocks,         
   int*                  sdpblocksizes,      
   int*                  sdpnblockvars,      
   int                   sdpconstnnonz,      
   int*                  sdpconstnblocknonz, 
   int**                 sdpconstrow,        
   int**                 sdpconstcol,        
   SCIP_Real**           sdpconstval,        
   int                   sdpnnonz,           
   int**                 sdpnblockvarnonz,   
   int**                 sdpvar,             
   int***                sdprow,             
   int***                sdpcol,             
   SCIP_Real***          sdpval,             
   int                   nlpcons,            
   SCIP_Real*            lplhs,              
   SCIP_Real*            lprhs,              
   int                   lpnnonz,            
   int*                  lprow,              
   int*                  lpcol,              
   SCIP_Real*            lpval               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiAddLPRows(
   SCIP_SDPI*            sdpi,               
   int                   nrows,              
   const SCIP_Real*      lhs,                
   const SCIP_Real*      rhs,                
   int                   nnonz,              
   const int*            row,                
   const int*            col,                
   const SCIP_Real*      val                 
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiDelLPRows(
   SCIP_SDPI*            sdpi,               
   int                   firstrow,           
   int                   lastrow             
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiDelLPRowset(
   SCIP_SDPI*            sdpi,               
   int*                  dstat               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiClear(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiChgObj(
   SCIP_SDPI*            sdpi,               
   int                   nvars,              
   const int*            ind,                
   const SCIP_Real*      obj                 
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiChgBounds(
   SCIP_SDPI*            sdpi,               
   int                   nvars,              
   const int*            ind,                
   const SCIP_Real*      lb,                 
   const SCIP_Real*      ub                  
   );

SCIP_RETCODE SCIPsdpiChgLPLhRhSides(
   SCIP_SDPI*            sdpi,               
   int                   nrows,              
   const int*            ind,                
   const SCIP_Real*      lhs,                
   const SCIP_Real*      rhs                 
   );


/*
 * Data Accessing Methods
 */

SCIP_MESSAGEHDLR* SCIPsdpiGetMessagehdlr(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetNLPRows(
   SCIP_SDPI*            sdpi,               
   int*                  nlprows             
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetNSDPBlocks(
   SCIP_SDPI*            sdpi,               
   int*                  nsdpblocks          
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetNVars(
   SCIP_SDPI*            sdpi,               
   int*                  nvars               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetSDPNNonz(
   SCIP_SDPI*            sdpi,               
   int*                  nnonz               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetConstNNonz(
   SCIP_SDPI*            sdpi,               
   int*                  nnonz               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetLPNNonz(
   SCIP_SDPI*            sdpi,               
   int*                  nnonz               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetObj(
   SCIP_SDPI*            sdpi,               
   int                   firstvar,           
   int                   lastvar,            
   SCIP_Real*            vals                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetBounds(
   SCIP_SDPI*            sdpi,               
   int                   firstvar,           
   int                   lastvar,            
   SCIP_Real*            lbs,                
   SCIP_Real*            ubs                 
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetLhSides(
   SCIP_SDPI*            sdpi,               
   int                   firstrow,           
   int                   lastrow,            
   SCIP_Real*            lhss                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetRhSides(
   SCIP_SDPI*            sdpi,               
   int                   firstrow,           
   int                   lastrow,            
   SCIP_Real*            rhss                
   );


/*
 * Solving Methods
 */

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiSolve(
   SCIP_SDPI*            sdpi,               
   SCIP_Real*            starty,             
   int*                  startZnblocknonz,   
   int**                 startZrow,          
   int**                 startZcol,          
   SCIP_Real**           startZval,          
   int*                  startXnblocknonz,   
   int**                 startXrow,          
   int**                 startXcol,          
   SCIP_Real**           startXval,          
   SCIP_SDPSOLVERSETTING startsettings,      
   SCIP_Bool             enforceslatercheck, 
   SCIP_Real             timelimit           
   );

/*
 * Solution Information Methods
 */

SCIP_EXPORT
SCIP_Bool SCIPsdpiWasSolved(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiSolvedOrig(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiFeasibilityKnown(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetSolFeasibility(
   SCIP_SDPI*            sdpi,               
   SCIP_Bool*            primalfeasible,     
   SCIP_Bool*            dualfeasible        
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsPrimalUnbounded(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsPrimalInfeasible(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsPrimalFeasible(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsDualUnbounded(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsDualInfeasible(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsDualFeasible(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsConverged(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsObjlimExc(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsIterlimExc(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsTimelimExc(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
int SCIPsdpiGetInternalStatus(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsOptimal(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsAcceptable(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetObjval(
   SCIP_SDPI*            sdpi,               
   SCIP_Real*            objval              
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetLowerObjbound(
   SCIP_SDPI*            sdpi,               
   SCIP_Real*            objlb               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetSol(
   SCIP_SDPI*            sdpi,               
   SCIP_Real*            objval,             
   SCIP_Real*            dualsol,            
   int*                  dualsollength       
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetPreoptimalPrimalNonzeros(
   SCIP_SDPI*            sdpi,               
   int                   nblocks,            
   int*                  startXnblocknonz    
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetPreoptimalSol(
   SCIP_SDPI*            sdpi,               
   SCIP_Bool*            success,            
   SCIP_Real*            dualsol,            
   int*                  dualsollength,      
   int                   nblocks,            
   int*                  startXnblocknonz,   
   int**                 startXrow,          
   int**                 startXcol,          
   SCIP_Real**           startXval           
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetPrimalBoundVars(
   SCIP_SDPI*            sdpi,               
   SCIP_Real*            lbvars,             
   SCIP_Real*            ubvars,             
   int*                  arraylength         
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetPrimalNonzeros(
   SCIP_SDPI*            sdpi,               
   int                   nblocks,            
   int*                  startXnblocknonz    
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetPrimalMatrix(
   SCIP_SDPI*            sdpi,               
   int                   nblocks,            
   int*                  startXnblocknonz,   
   int**                 startXrow,          
   int**                 startXcol,          
   SCIP_Real**           startXval           
   );

SCIP_EXPORT
SCIP_Real SCIPsdpiGetMaxPrimalEntry(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetTime(
   SCIP_SDPI*            sdpi,               
   SCIP_Real*            opttime             
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetIterations(
   SCIP_SDPI*            sdpi,               
   int*                  iterations          
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetSdpCalls(
   SCIP_SDPI*            sdpi,               
   int*                  calls               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiSettingsUsed(
   SCIP_SDPI*            sdpi,               
   SCIP_SDPSOLVERSETTING* usedsetting        
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiSlaterSettings(
   SCIP_SDPI*            sdpi,               
   SCIP_SDPSLATERSETTING* slatersetting      
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiSlater(
   SCIP_SDPI*            sdpi,               
   SCIP_SDPSLATER*       primalslater,       
   SCIP_SDPSLATER*       dualslater          
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetStatistics(
   SCIP_SDPI*            sdpi,               
   int*                  ninfeasible,        
   int*                  nallfixed,          
   int*                  nonevarsdp          
   );

/*
 * SDPi State Methods
 */



/*
 * Numerical Methods
 */

SCIP_EXPORT
SCIP_Real SCIPsdpiInfinity(
   SCIP_SDPI*            sdpi                
   );

SCIP_EXPORT
SCIP_Bool SCIPsdpiIsInfinity(
   SCIP_SDPI*            sdpi,               
   SCIP_Real             val                 
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetRealpar(
   SCIP_SDPI*            sdpi,               
   SCIP_SDPPARAM         type,               
   SCIP_Real*            dval                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiSetRealpar(
   SCIP_SDPI*            sdpi,               
   SCIP_SDPPARAM         type,               
   SCIP_Real             dval                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiGetIntpar(
   SCIP_SDPI*            sdpi,               
   SCIP_SDPPARAM         type,               
   int*                  ival                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiSetIntpar(
   SCIP_SDPI*            sdpi,               
   SCIP_SDPPARAM         type,               
   int                   ival                
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiComputeLambdastar(
   SCIP_SDPI*            sdpi,               
   SCIP_Real             maxguess            
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiComputePenaltyparam(
   SCIP_SDPI*            sdpi,               
   SCIP_Real             maxcoeff,           
   SCIP_Real*            penaltyparam        
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiComputeMaxPenaltyparam(
   SCIP_SDPI*            sdpi,               
   SCIP_Real             penaltyparam,       
   SCIP_Real*            maxpenaltyparam     
   );

SCIP_EXPORT
void SCIPsdpiClockSetType(
   SCIP_SDPI*            sdpi,               
   int                   clocktype           
   );

/*
 * File Interface Methods
 */

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiReadSDP(
   SCIP_SDPI*            sdpi,               
   const char*           fname               
   );

SCIP_EXPORT
SCIP_RETCODE SCIPsdpiWriteSDP(
   SCIP_SDPI*            sdpi,               
   const char*           fname               
   );

#ifdef __cplusplus
}
#endif

#endif