Scippy

    SCIP

    Solving Constraint Integer Programs

    Public Member Functions
    SCIPNLFeeder Class Reference

    Detailed Description

    Definition at line 1743 of file reader_nl.cpp.

    Public Member Functions

     SCIPNLFeeder (SCIP *scip_, const char *probname_, SCIP_OBJSENSE objsense_, SCIP_Real objscale_, SCIP_Real objoffset_, SCIP_VAR **vars_, int nvars_, SCIP_VAR **fixedvars_, int nfixedvars_, SCIP_CONS **conss_, int nconss_, SCIP_Bool nlbinary_, SCIP_Bool nlcomments_, SCIP_Bool genericnames_)
     Constructor. More...
     
     ~SCIPNLFeeder ()
     
    mp::NLHeader Header ()
     
    bool WantNLComments () const
     NL comments? More...
     
    int WantColumnSizes () const
     
    int ObjType (int) const
     
    template<class ObjGradWriter >
    void FeedObjGradient (int i, ObjGradWriter &gw)
     
    template<class ObjExprWriter >
    void FeedObjExpression (int i, ObjExprWriter &ew)
     
    template<class VarBoundsWriter >
    void FeedVarBounds (VarBoundsWriter &vbw) const
     
    template<class ConBoundsWriter >
    void FeedConBounds (ConBoundsWriter &cbw)
     
    const char * ConDescription (int i)
     
    template<class ConLinearExprWriter >
    void FeedLinearConExpr (int i, ConLinearExprWriter &clw)
     
    template<class ConExprWriter >
    void FeedConExpression (int i, ConExprWriter &ew)
     
    template<class RowObjNameWriter >
    void FeedRowAndObjNames (RowObjNameWriter &wrt) const
     
    template<class ColNameWriter >
    void FeedColNames (ColNameWriter &wrt) const
     

    Constructor & Destructor Documentation

    ◆ SCIPNLFeeder()

    SCIPNLFeeder::SCIPNLFeeder ( SCIP *  scip_,
    const char *  probname_,
    SCIP_OBJSENSE  objsense_,
    SCIP_Real  objscale_,
    SCIP_Real  objoffset_,
    SCIP_VAR **  vars_,
    int  nvars_,
    SCIP_VAR **  fixedvars_,
    int  nfixedvars_,
    SCIP_CONS **  conss_,
    int  nconss_,
    SCIP_Bool  nlbinary_,
    SCIP_Bool  nlcomments_,
    SCIP_Bool  genericnames_ 
    )
    		inline

    Constructor.

    Parameters
    scip_SCIP data structure
    probname_problem name
    objsense_objective sense
    objscale_objective scale
    objoffset_objective offset
    vars_active variables
    nvars_number of active variables
    fixedvars_fixed variables
    nfixedvars_number of fixed variables
    conss_constraints
    nconss_number of constraints
    nlbinary_whether to write binary or text nl
    nlcomments_whether to include comments into nl
    genericnames_are generic names used

    Definition at line 2176 of file reader_nl.cpp.

    References SCIPfindConshdlr().

    ◆ ~SCIPNLFeeder()

    SCIPNLFeeder::~SCIPNLFeeder ( )
    		inline

    Definition at line 2225 of file reader_nl.cpp.

    References NULL, SCIPfreeBlockMemoryArrayNull, and SCIPhashmapFree().

    Member Function Documentation

    ◆ Header()

    mp::NLHeader SCIPNLFeeder::Header ( )
    		inline

    Provide NLHeader.

    This method is called first.

    NLHeader summarizes the model and provides some technical parameters, such as text/binary NL format.

    Definition at line 2243 of file reader_nl.cpp.

    ◆ WantNLComments()

    bool SCIPNLFeeder::WantNLComments ( ) const
    		inline

    NL comments?

    Definition at line 2276 of file reader_nl.cpp.

    ◆ WantColumnSizes()

    int SCIPNLFeeder::WantColumnSizes ( ) const
    		inline

    currently we do not want to write size of each column in Jacobian (i.e., number of constraints each variable appears in)

    Definition at line 2283 of file reader_nl.cpp.

    ◆ ObjType()

    int SCIPNLFeeder::ObjType ( int  ) const
    		inline

    Definition at line 2288 of file reader_nl.cpp.

    References SCIP_OBJSENSE_MAXIMIZE.

    ◆ FeedObjGradient()

    template<class ObjGradWriter >
    void SCIPNLFeeder::FeedObjGradient ( int  i,
    ObjGradWriter &  gw 
    )
    		inline

    Definition at line 2296 of file reader_nl.cpp.

    References SCIP_Real, and SCIPvarGetObj().

    ◆ FeedObjExpression()

    template<class ObjExprWriter >
    void SCIPNLFeeder::FeedObjExpression ( int  i,
    ObjExprWriter &  ew 
    )
    		inline

    Definition at line 2316 of file reader_nl.cpp.

    ◆ FeedVarBounds()

    template<class VarBoundsWriter >
    void SCIPNLFeeder::FeedVarBounds ( VarBoundsWriter &  vbw) const
    		inline

    Definition at line 2326 of file reader_nl.cpp.

    References SCIP_Real, SCIPisInfinity(), SCIPvarGetLbGlobal(), and SCIPvarGetUbGlobal().

    ◆ FeedConBounds()

    template<class ConBoundsWriter >
    void SCIPNLFeeder::FeedConBounds ( ConBoundsWriter &  cbw)
    		inline

    Definition at line 2346 of file reader_nl.cpp.

    References SCIP_CALL_THROW, SCIP_ERROR, SCIP_VARSTATUS_AGGREGATED, SCIP_VARSTATUS_MULTAGGR, SCIP_VARSTATUS_NEGATED, SCIPerrorMessage, SCIPisInfinity(), SCIPvarGetAggrConstant(), SCIPvarGetMultaggrConstant(), SCIPvarGetName(), SCIPvarGetNegationConstant(), and SCIPvarGetStatus().

    ◆ ConDescription()

    const char * SCIPNLFeeder::ConDescription ( int  i)
    		inline

    Definition at line 2388 of file reader_nl.cpp.

    References SCIPconsGetName(), and SCIPvarGetName().

    ◆ FeedLinearConExpr()

    template<class ConLinearExprWriter >
    void SCIPNLFeeder::FeedLinearConExpr ( int  i,
    ConLinearExprWriter &  clw 
    )
    		inline

    Definition at line 2400 of file reader_nl.cpp.

    References SCIP_CALL_THROW, SCIP_ERROR, SCIP_Longint, SCIP_Real, SCIP_VARSTATUS_AGGREGATED, SCIP_VARSTATUS_MULTAGGR, SCIP_VARSTATUS_NEGATED, SCIPconsGetHdlr(), SCIPerrorMessage, SCIPgetNVarsKnapsack(), SCIPgetNVarsLinear(), SCIPgetNVarsLogicor(), SCIPgetNVarsSetppc(), SCIPgetValsLinear(), SCIPgetVarsKnapsack(), SCIPgetVarsLinear(), SCIPgetVarsLogicor(), SCIPgetVarsSetppc(), SCIPgetVarVarbound(), SCIPgetVbdcoefVarbound(), SCIPgetVbdvarVarbound(), SCIPgetWeightsKnapsack(), SCIPvarGetAggrScalar(), SCIPvarGetAggrVar(), SCIPvarGetMultaggrNVars(), SCIPvarGetMultaggrScalars(), SCIPvarGetMultaggrVars(), SCIPvarGetName(), SCIPvarGetNegationVar(), SCIPvarGetStatus(), and SCIPvarIsNegated().

    ◆ FeedConExpression()

    template<class ConExprWriter >
    void SCIPNLFeeder::FeedConExpression ( int  i,
    ConExprWriter &  ew 
    )
    		inline

    Definition at line 2549 of file reader_nl.cpp.

    References ABS, NULL, SCIP_EXPRITER_USERDATA::ptrval, SCIP_CALL_THROW, SCIP_EXPRITER_ALLSTAGES, SCIP_EXPRITER_DFS, SCIP_EXPRITER_ENTEREXPR, SCIP_EXPRITER_LEAVEEXPR, SCIP_EXPRITER_VISITEDCHILD, SCIP_EXPRITER_VISITINGCHILD, SCIP_Real, SCIPallocClearBufferArray, SCIPconsGetName(), SCIPcreateExpriter(), SCIPexprGetHdlr(), SCIPexprGetNChildren(), SCIPexprhdlrGetName(), SCIPexpriterGetChildIdxDFS(), SCIPexpriterGetCurrent(), SCIPexpriterGetCurrentUserData(), SCIPexpriterGetExprUserData(), SCIPexpriterGetNext(), SCIPexpriterGetParentDFS(), SCIPexpriterGetStageDFS(), SCIPexpriterInit(), SCIPexpriterIsEnd(), SCIPexpriterSetCurrentUserData(), SCIPexpriterSetStagesDFS(), SCIPexpriterSkipDFS(), SCIPfreeBufferArray, SCIPfreeExpriter(), SCIPgetCoefsExprSum(), SCIPgetConstantExprSum(), SCIPgetExponentExprPow(), SCIPgetExprNonlinear(), SCIPgetValueExprValue(), SCIPgetVarExprVar(), SCIPisExprAbs(), SCIPisExprCos(), SCIPisExprExp(), SCIPisExprLog(), SCIPisExprPower(), SCIPisExprProduct(), SCIPisExprSin(), SCIPisExprSum(), SCIPisExprValue(), SCIPisExprVar(), SCIPvarGetName(), SCIPvarGetNegatedVar(), SCIPvarGetNegationConstant(), SCIPvarIsNegated(), and TRUE.

    ◆ FeedRowAndObjNames()

    template<class RowObjNameWriter >
    void SCIPNLFeeder::FeedRowAndObjNames ( RowObjNameWriter &  wrt) const
    		inline

    Definition at line 2824 of file reader_nl.cpp.

    References SCIPconsGetName(), and SCIPvarGetName().

    ◆ FeedColNames()

    template<class ColNameWriter >
    void SCIPNLFeeder::FeedColNames ( ColNameWriter &  wrt) const
    		inline

    Definition at line 2845 of file reader_nl.cpp.

    References SCIPvarGetName().