Optimize_First_Objective: Load and Optimize the first Objective Function

In paymanghasemi/SiteOpt: SiteOpt: an Open-source R-package for Site Selection Optimization in Conservation Planning

Load and Optimize the first Objective Function

Description

Optimize_First_Objective loads the optimization problem and optimizes First_Objective in Julia environment.

Usage

Optimize_First_Objective(Time_limit=1e7, Solver="SCIP",
                                Silence= FALSE, Env= .GlobalEnv)

Arguments

Time_limit	A double: the total time limit in seconds
Solver	A string: defining the solver to be used to solve the problem. (Default: "SCIP")
Silence	A binary parameter: if FALSE, the function will report a summary message. If TRUE, the function will be silent. (Default: FALSE)
Env	the environment where the package should create or access variables. By default the package works in the R's Global environment. (Default: .GlobalEnv)

Details

In the list that Optimize_First_Objective returns, ⁠[["Status"]]⁠ defines the status of the returned solution.
If ⁠[["Status"]]="OPTIMAL"⁠, the problem was solved to optimality and the parcels' optimal status are stored in ⁠[["Result"]]⁠. Also, the optimal value will be stored in ⁠[["Objective_Value"]]⁠.
If ⁠[["Status"]]="TIME_LIMIT"⁠, the solver was terminated because the time limit was reached. If any feasible solution was reported by the solver, it would be stored in ⁠[["Result"]]⁠. Otherwise, ⁠[["Result"]]⁠ and ⁠[["Objective_Value"]]⁠ would be both equal to "N/A".
If ⁠[["Status"]]="INFEASIBLE"⁠, the problem is infeasible. So, no solution would be reported.

In any other case, the ⁠[["Status"]]⁠ will be the solution status that the solver has reported.

Value

A list with 5 members:
⁠[["Solution_time"]]⁠: a numeric value; defining the time spent in the solver in seconds.
⁠[["Status"]]⁠: a character; defining the status of the solution.
⁠[["Gap"]]⁠: a numeric value; defining the relative optimality gap of the solution.
⁠[["Result"]]⁠: a vector of binaries; its i'th element defines if the parcel named Parcels[i] is protected or not in the optimal solution. Comparing these values with the values of Status defined when creating the problem, the user can find which parcels are to be invested, divested, or remain the same.
⁠[["Objective_Value"]]⁠: a numveric value; the returned value of First objective.

See Also

Other Optimizer Functions: Load_Problem(), Optimize_NBP(), Optimize_Second_Objective(), Optimize_WSO()

Other First Objective: First_Objective_Create(), First_Objective_Import()

Examples

## Not run: 

Optimization_Result = Optimize_First_Objective(Time_limit=1e7, Solver="SCIP")

## End(Not run)

paymanghasemi/SiteOpt documentation built on May 18, 2024, 2:06 p.m.