Package 'rminizinc'

Title: R Interface to 'MiniZinc'
Description: Constraint optimization, or constraint programming, is the name given to identifying feasible solutions out of a very large set of candidates, where the problem can be modeled in terms of arbitrary constraints. 'MiniZinc' is a free and open-source constraint modeling language. Constraint satisfaction and discrete optimization problems can be formulated in a high-level modeling language. Models are compiled into an intermediate representation that is understood by a wide range of solvers. 'MiniZinc' itself provides several solvers, for instance 'GeCode'. R users can use the package to solve constraint programming problems without using 'MiniZinc' directly, modify existing 'MiniZinc' models and also create their own models.
Authors: Akshit Achara, Lars Kotthoff, Hans W. Borchers, Guido Tack
Maintainer: Akshit Achara <[email protected]>
License: Mozilla Public License Version 2.0
Version: 0.0.8
Built: 2025-02-22 04:10:32 UTC
Source: https://github.com/acharaakshit/rminizinc

Help Index

rminizinc: R Interface to 'MiniZinc'

Description

Load the required libraries used by most of the functions and classes

See Also

Useful links:

Annotation

Description

Create Annotations in MiniZinc

Public fields

.expVec

list of expressions

.delete_flag

used to delete items

Active bindings

.expVec

list of expressions

.delete_flag

used to delete items

Methods

Public methods

Method new()

constructor

Usage
Annotation$new(expVec)
Arguments
expVec

vector of MiniZinc expressions

Method getExps()

get the list of expressions

Usage
Annotation$getExps()

Method setExps()

set the list of expressions

Usage
Annotation$setExps(expVec)
Arguments
expVec

list of expressions to be set

Method c_str()

get the MiniZinc expression

Usage
Annotation$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Annotation$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Annotation$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Annotation$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

create an array

Description

Create an array in MiniZinc

Super class

rminizinc::Expression -> Array

Public fields

.exprVec

vector of value expressions

.dims

vector of dimension expressions

.delete_flag

used to delete items

Active bindings

.exprVec

vector of value expressions

.dims

vector of dimension expressions

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor for an int literal

Usage
Array$new(exprVec, dimranges = NULL)
Arguments
exprVec

list of expressions in the array

dimranges

list of min and max index of each dimension

Method ndims()

get the number of dimensions

Usage
Array$ndims()

Method getMinIndex()

get the minimum index of dimension i

Usage
Array$getMinIndex(i)
Arguments
i

ith dimension

Method getMaxIndex()

get the maximum index of dimension i

Usage
Array$getMaxIndex(i)
Arguments
i

ith dimension

Method setMinIndex()

set the minimum index of dimension i

Usage
Array$setMinIndex(i, minIndex)
Arguments
i

dimension number

minIndex

integer for min index

Method setMaxIndex()

set the maximum index of dimension i

Usage
Array$setMaxIndex(i, maxIndex)
Arguments
i

dimension number

maxIndex

integer for max index

Method getVal()

get the ith element from vector

Usage
Array$getVal(i)
Arguments
i

index

Method setVal()

set the ith element from vector

Usage
Array$setVal(i, val)
Arguments
i

index

val

value of expression to be set

Method c_str()

return the MiniZinc representation

Usage
Array$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Array$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Array$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Array$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newArray = Array$new(exprVec = c(Int$new(1), Int$new(2)))
newArray$c_str()

Array Access

Description

Create ArrayAccess elements in MiniZinc

Super class

rminizinc::Expression -> ArrayAccess

Public fields

.v

the id/value of array

.args

arguments of the array

.delete_flag

used to delete items

Active bindings

.v

the id/value of array

.args

arguments of the array

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
ArrayAccess$new(v, args)
Arguments
v

the value/identifier of variable decl

args

the array indices

Method getV()

get the array access value

Usage
ArrayAccess$getV()

Method setV()

set the array access value

Usage
ArrayAccess$setV(val)
Arguments
val

new array access value

Method nargs()

get the number of arguments

Usage
ArrayAccess$nargs()

Method getArgs()

get the arguments

Usage
ArrayAccess$getArgs()

Method setArgs()

set the arguments

Usage
ArrayAccess$setArgs(val)
Arguments
val

new arguments

Method c_str()

return the MiniZinc representation

Usage
ArrayAccess$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
ArrayAccess$getDeleteFlag()

Method delete()

delete the assignment item

Usage
ArrayAccess$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
ArrayAccess$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

vDecl1 = IntSetDecl(name = "SET", kind = "par")
vDecl2 = IntArrDecl(name = "profit", kind = "par", ndim = 1, 
ind = list(vDecl1$getId()))
newArrayAccess = ArrayAccess$new(v = vDecl2$getId(),
 args = list(IntDecl(name = "i", kind = "par")))

declare n-D array with domain

Description

Declare a n-dimensional array with domain

Usage

ArrDomainDecl(name, kind, dom, ndim)

Arguments

name

variable name
kind

variable or parameter
dom

domain
ndim

number of dimensions

Assignment Items

Description

Assign values to variables in MiniZinc by creating an assignment item.

Super class

rminizinc::Item -> AssignItem

Public fields

.decl

associated declaration

.e

value to be assigned

.delete_flag

used to delete items

Active bindings

.decl

associated declaration

.e

value to be assigned

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
AssignItem$new(decl, value)
Arguments
decl

declaration associated with assignment.

value

expression to be assigned.

Method id()

get the name of assigned variable

Usage
AssignItem$id()

Method getValue()

get the value

Usage
AssignItem$getValue()

Method setValue()

set the value

Usage
AssignItem$setValue(val)
Arguments
val

value/expression to be set

Method getDecl()

get the associated declaration

Usage
AssignItem$getDecl()

Method setDecl()

set the associated declaration

Usage
AssignItem$setDecl(decl)
Arguments
decl

declaration to be set

Method c_str()

get the MiniZinc representation

Usage
AssignItem$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
AssignItem$getDeleteFlag()

Method delete()

delete the assignment item

Usage
AssignItem$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
AssignItem$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

assignment problem 2

Description

Solve an assignment problem (Goal is to minimize the cost)

Usage

assignment(n, m, cost)

Arguments

n

number of agents
m

number of tasks
cost

m x n 2D array where each row corresponds to the cost of each task for that agent. (to be provided as 1-D vector)

assignment problem 2

Description

Solve an assignment problem Winston "Operations Research", page 398, swimming team example Model created by Hakan Kjellerstrand(hakank(at)bonetmail.com) See : http://www.hakank.org/minizinc/assignment2.mzn

Usage

assignment_2(rows, cols, cost)

Arguments

rows

number of columns
cols

number of tasks
cost

cost matrix (to be provided as 1-D vector)

BinOp

Description

Create a binary operation expression possible binary operators are: "+", "-", "!=", "<->", ">=", "<=", "*", ">", "<", "->", "<-", "..", "\/", "/\", "'not'", "subset", "superset", "union", "diff", "symdiff", "intersect", "^", "div", "mod", "/", "++", "xor", "in", "="

Super class

rminizinc::Expression -> BinOp

Public fields

.lhs_exp

the left hand side expression

.rhs_exp

the right hand side expression

.op

the operator

.delete_flag

used to delete items

Active bindings

.lhs_exp

the left hand side expression

.rhs_exp

the right hand side expression

.op

the operator

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
BinOp$new(lhs, binop, rhs)
Arguments
lhs

the left hand side expression

binop

the binary operator to be used

rhs

the right hand side expression

Method getLhs()

get the lhs expression

Usage
BinOp$getLhs()

Method getRhs()

get the rhs expression

Usage
BinOp$getRhs()

Method getOp()

get the operator

Usage
BinOp$getOp()

Method setOp()

set the operator

Usage
BinOp$setOp(binop)
Arguments
op

binary operator to be set

Method setLhs()

set the lhs expression

Usage
BinOp$setLhs(e)
Arguments
e

expression to set

Method setRhs()

set the rhs expression

Usage
BinOp$setRhs(e)
Arguments
e

expression to set

Method c_str()

return the MiniZinc representation

Usage
BinOp$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
BinOp$getDeleteFlag()

Method delete()

delete the assignment item

Usage
BinOp$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
BinOp$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newBinOp = BinOp$new(lhs = Int$new(2), binop = "+", rhs = Int$new(5))
newBinOp$c_str()
newBinOp$setLhs(Int$new(5))
newBinOp$setOp("-")
newBinOp$setRhs(Int$new(2))
newBinOp$c_str()

Bool

Description

Create a bool in MiniZinc

Super class

rminizinc::Expression -> Bool

Public fields

.value

value

Active bindings

.value

value

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Bool$new(val)
Arguments
val

boolean input

Method v()

get boolean value

Usage
Bool$v()

Method c_str()

get the MiniZinc representation

Usage
Bool$c_str()

Method clone()

The objects of this class are cloneable with this method.

Usage
Bool$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newBool = Bool$new(TRUE)
newBool$c_str()

n-D bool array declaration

Description

Declare a new n-dimensional array of bools

Usage

BoolArrDecl(name, kind, ind, value = NULL, ndim)

Arguments

name

variable/parameter name
kind

"var" or "par"
ind

index of the array
value

value (NULL by default)
ndim

number of dimensions of the array

new bool declaration

Description

Declare a new bool

Usage

BoolDecl(name, kind, value = NULL)

Arguments

name

variable/parameter name
kind

"var" or "par"
value

provide TRUE or FALSE (NULL by default)

get bools

Description

Get a list of bool expressions

Usage

boolExpressions(vals)

Arguments

vals

vector of bool values

set of bool declaration

Description

Declare a new set of bool

Usage

BoolSetDecl(name, kind, value = NULL)

Arguments

name

variable/parameter name
kind

"var" or "par"
value

provide a Set object (or NULL)

Call

Description

Create function calls in MiniZinc

Super class

rminizinc::Expression -> Call

Public fields

.id

the function id

.lExp

list of expressions

.delete_flag

used to delete items

Active bindings

.id

the function id

.lExp

list of expressions

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Call$new(fnName, args)
Arguments
fnName

function name

args

the list of expressions

Method getName()

get the function id/string

Usage
Call$getName()

Method setName()

get the function id/string

Usage
Call$setName(name)
Arguments
name

new function name

Method nargs()

get the number of arguments

Usage
Call$nargs()

Method getArgs()

get the expression list

Usage
Call$getArgs()

Method setArgs()

set the expression list

Usage
Call$setArgs(args)
Arguments
args

list of expressions to be set

Method getArg()

get the expression based on index

Usage
Call$getArg(i)
Arguments
i

index

Method setArg()

set argument i

Usage
Call$setArg(e, i)
Arguments
e

expression

i

index

Method c_str()

return the MiniZinc representation

Usage
Call$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Call$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Call$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Call$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newCall = Call$new(fnName = "sum", args = list(Int$new(2), Int$new(5)))
newCall$c_str()

Comprehension

Description

Create a Comprehension in MiniZinc

Super class

rminizinc::Expression -> Comprehension

Public fields

.generators

a vector of generators

.expression

the comprehension expression

.set

TRUE if comprehension is a set

.delete_flag

used to delete items

Active bindings

.generators

a vector of generators

.expression

the comprehension expression

.set

TRUE if comprehension is a set

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Comprehension$new(generators, body, set)
Arguments
generators

generators of the expression

body

body/expression of the comprehension

set

bool to specify if comprehension is a set.

Method ngens()

get the number of generators

Usage
Comprehension$ngens()

Method getGens()

get all the generator expressions

Usage
Comprehension$getGens()

Method setGens()

set all the generator expressions

Usage
Comprehension$setGens(generators)
Arguments
generators

list of generator expressions to be set

Method getGen()

get the ith generator expression

Usage
Comprehension$getGen(i)
Arguments
i

index

Method setGen()

set the ith generator expression

Usage
Comprehension$setGen(i, expGen)
Arguments
i

index

expGen

generator expression to be set

Method getBody()

get the expression/body

Usage
Comprehension$getBody()

Method setBody()

set the expression/body

Usage
Comprehension$setBody(e)
Arguments
e

new expression value

Method isSet()

check if comprehension is a set

Usage
Comprehension$isSet()

Method c_str()

get the MiniZinc representation

Usage
Comprehension$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Comprehension$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Comprehension$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Comprehension$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Constraint Items

Description

Describe Minizinc constraints on decision variables.

Super class

rminizinc::Item -> ConstraintItem

Public fields

.e

the constraint expression

.delete_flag

used to delete items

Active bindings

.e

the constraint expression

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

Creates a new instance of Constraint class.

Usage
ConstraintItem$new(e = NULL, mzn_str = NULL)
Arguments
e

The expression for the constraint (used if e is NULL)

mzn_str

string representation of Constraint item

Method getExp()

get the constraint expression

Usage
ConstraintItem$getExp()

Method setExp()

set the constraint expression

Usage
ConstraintItem$setExp(e)
Arguments
e

expression

Method c_str()

serialize to MiniZinc syntax

Usage
ConstraintItem$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
ConstraintItem$getDeleteFlag()

Method delete()

delete the constraint item

Usage
ConstraintItem$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
ConstraintItem$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Expression (Abstract class – should not be initialized)

Description

This class represents an expression in MiniZinc.

Methods

Public methods

Method new()

constructor

Usage
Expression$new()

Method clone()

The objects of this class are cloneable with this method.

Usage
Expression$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

delete an expression

Description

Delete the object everywhere from the MiniZinc model

Usage

expressionDelete(classNm, model)

Arguments

classNm

class of the object to delete
model

model to delete the object from

Float

Description

Create a float in MiniZinc

Super class

rminizinc::Expression -> Float

Public fields

.value

object of class expression

Active bindings

.value

object of class expression

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Float$new(val)
Arguments
val

the float value

Method getFloatVal()

get the float value

Usage
Float$getFloatVal()

Method setFloatVal()

set the float value

Usage
Float$setFloatVal(val)
Arguments
val

value to be set

Method c_str()

get the MiniZinc representation

Usage
Float$c_str()

Method clone()

The objects of this class are cloneable with this method.

Usage
Float$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newFloat = Float$new(1.5)
newFloat$c_str()
newFloat$setFloatVal(newFloat$getFloatVal() + 2.5)
newFloat$c_str()

n-D float array declaration

Description

Declare a new n-dimensional array of float

Usage

FloatArrDecl(name, kind, ind, value = NULL, ndim)

Arguments

name

variable/parameter name
kind

"var" or "par"
ind

index of the array
value

value (NULL by default)
ndim

number of dimensions of the array

float declaration

Description

Declare a new float

Usage

FloatDecl(name, kind, value = NULL, domain = NULL)

Arguments

name

variable/parameter name
kind

"var" or "par"
value

pass a numeric/double value in R (NULL by default)
domain

domain of the float variable (NULL by default)

get floats

Description

Get a list of floats expressions

Usage

floatExpressions(vals)

Arguments

vals

vector of floats values

set of float declaration

Description

Declare a new set of float

Usage

FloatSetDecl(name, kind, value = NULL)

Arguments

name

variable/parameter name
kind

"var" or "par"
value

provide an FloatSetVal object (or NULL)

Float set value

Description

float set range in MiniZinc

Public fields

.min

minimum FloatVal

.max

maximum FloatVal

Active bindings

.min

minimum FloatVal

.max

maximum FloatVal

Methods

Public methods

Method new()

constructor

Usage
FloatSetVal$new(fmin, fmax)
Arguments
fmin

the minimum FloatVal

fmax

the maximum FloatVal

Method getMin()

get the minimum float value

Usage
FloatSetVal$getMin()

Method setMin()

set the minimum float value

Usage
FloatSetVal$setMin(val)
Arguments
val

float value to be set

Method getMax()

get the maximum float value

Usage
FloatSetVal$getMax()

Method setMax()

set the maximum float value

Usage
FloatSetVal$setMax(val)
Arguments
val

float value to be set

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatSetVal$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

FloatVal class (not exposed to user)

Description

create a Float Value in MiniZinc

Public fields

.val

the integer value

Active bindings

.val

the integer value

Methods

Public methods

Method new()

constructor

Usage
FloatVal$new(val)
Arguments
val

float value to be assigned

Method v()

return the value

Usage
FloatVal$v()

Method clone()

The objects of this class are cloneable with this method.

Usage
FloatVal$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Function Items

Description

Create Independent functions (that are not part of any other items) in a MiniZinc model

Super class

rminizinc::Item -> FunctionItem

Public fields

.id

name of the function

.e

expression in the function

.decls

parameter declarations

.ann

annotation

.ti

return type of the function

.delete_flag

used to delete items

Active bindings

.id

name of the function

.e

expression in the function

.decls

parameter declarations

.ann

annotation

.ti

return type of the function

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
FunctionItem$new(
  name = NULL,
  decls = NULL,
  rt = NULL,
  ann = NULL,
  body = NULL,
  mzn_str = NULL
)
Arguments
name

name of the function

decls

variable declarations

rt

the return type ("bool par", "bool var" or other)

ann

annotation

body

body of the function

mzn_str

string representation of Function Item

Method name()

get the name of the function

Usage
FunctionItem$name()

Method getDecls()

get the list of declarations

Usage
FunctionItem$getDecls()

Method getBody()

get the function body

Usage
FunctionItem$getBody()

Method getAnn()

get the function annotation

Usage
FunctionItem$getAnn()

Method setDecls()

set the list of declarations

Usage
FunctionItem$setDecls(decls)
Arguments
decls

list of declarations to be set

Method setBody()

set the function body

Usage
FunctionItem$setBody()
Arguments
body

function expression to set or NULL

Method setAnn()

set the function annotation

Usage
FunctionItem$setAnn()
Arguments
ann

annotation to be set or NULL

Method rtype()

get if the function is a test, predicate or a function call itself.

Usage
FunctionItem$rtype()

Method c_str()

get the MiniZinc representation

Usage
FunctionItem$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
FunctionItem$getDeleteFlag()

Method delete()

delete the variable item

Usage
FunctionItem$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
FunctionItem$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Generator

Description

Create a generator in MiniZinc

Super class

rminizinc::Expression -> Generator

Public fields

.decls

variable declarations

.in

in expression

where

where expression

.delete_flag

used to delete items

Active bindings

.decls

variable declarations

.in

in expression

where

where expression

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Generator$new(decls, IN = NULL, where = NULL)
Arguments
decls

list of variable declarations

IN

the in expression of generator

where

the where expression of generator

Method getIn()

get the in expression

Usage
Generator$getIn()

Method setIn()

set the in expression

Usage
Generator$setIn(expIn)
Arguments
expIn

expression to be set

Method getWhere()

get the where expression

Usage
Generator$getWhere()

Method setWhere()

get the where expression

Usage
Generator$setWhere(expWhere)
Arguments
expWhere

where expression (or NULL)

Method getDecl()

get the ith declaration

Usage
Generator$getDecl(i)
Arguments
i

index

Method setDecl()

get the ith declaration

Usage
Generator$setDecl(i, decl)
Arguments
i

index

decl

declaration to be set

Method c_str()

get the MiniZinc representation

Usage
Generator$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Generator$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Generator$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Generator$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newGen = Generator$new(IN = IntSetDecl(name = "SET", kind = "par"), 
decls = list(IntDecl(name = "i", kind = "par")))

get missing parameters

Description

Get the values of the missing parameters

Usage

get_missing_pars(model)

Arguments

model

object of Model class

init all classes

Description

Given the return value of 'mzn_parse()', it creates a model in R using the API mirror

Usage

getRModel(mznParseList)

Arguments

mznParseList

list input

initialized type (not exposed to user)

Description

Helper function to initialise the type.

Usage

getType(type_str, kind)

Arguments

type_str

type string returned by 'parse_mzn()'.
kind

par or var

helper delete expression

Description

helper function to search the through a model for an expression and return the object if found

Usage

helperDeleteExpression(classNm)

Arguments

classNm

name of the object class

helper delete item

Description

Helper function to search the through a model for an item and return the object if found

Usage

helperDeleteItem(classNm)

Arguments

classNm

name of the object class

Id class (not exposed to the user)

Description

Create a new Id in MiniZinc

Super class

rminizinc::Expression -> Id

Public fields

.id

the string identifier

.delete_flag

used to delete items

Active bindings

.id

the string identifier

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Id$new(id)
Arguments
id

id to be created

Method getName()

get the string identifier

Usage
Id$getName()

Method setName()

set the string identifier

Usage
Id$setName(name)
Arguments
name

string name to set

Method c_str()

return the MiniZinc representation

Usage
Id$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Id$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Id$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Id$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Include Items

Description

Include external mzn files in your model.

Super class

rminizinc::Item -> IncludeItem

Public fields

.id

name of mzn file

.delete_flag

used to delete items

Active bindings

.id

name of mzn file

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
IncludeItem$new(name = NULL, mzn_str = NULL)
Arguments
name

name of the file to include

mzn_str

string representation of Include Item get file name set the file name

Method getmznName()

Usage
IncludeItem$getmznName()

Method setmznName()

Usage
IncludeItem$setmznName(name)
Arguments
name

name of file

Method c_str()

get the MiniZinc representation

Usage
IncludeItem$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
IncludeItem$getDeleteFlag()

Method delete()

delete the include item

Usage
IncludeItem$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
IncludeItem$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

initExpression (not exposed to the user)

Description

Recursive helper function for initilizing expression classes

Usage

initExpression(pList)

Arguments

pList

list from mzn_parse to initialise objects

initialize R6 from parsed (not to be exposed)

Description

Initialize all the R6 objects using the list returned by 'mzn_parse()' to create exactly the same structure in R.

Usage

initItem(parsedList)

Arguments

parsedList

list returned by 'mzn_parse()'

Int

Description

Create an integer in MiniZinc

Super class

rminizinc::Expression -> Int

Public fields

.value

object of class expression

Active bindings

.value

object of class expression

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Int$new(val)
Arguments
val

the value of the integer

Method getIntVal()

get the IntVal value

Usage
Int$getIntVal()

Method setIntVal()

set the IntVal value

Usage
Int$setIntVal(val)
Arguments
val

value to be set

Method c_str()

get the MiniZinc representation

Usage
Int$c_str()

Method clone()

The objects of this class are cloneable with this method.

Usage
Int$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newInt = Int$new(10)
newInt$c_str()
newInt$setIntVal(newInt$getIntVal() + 20)
newInt$c_str()

n-D int array declaration

Description

Declare a new n-dimensional array of int

Usage

IntArrDecl(name, kind, ind, value = NULL, ndim)

Arguments

name

variable/parameter name
kind

"var" or "par"
ind

index of the array
value

Array Object (NULL by default)
ndim

number of dimensions of the array

int declaration

Description

Declare a new int

Usage

IntDecl(name, kind, value = NULL, domain = NULL)

Arguments

name

variable/parameter name
kind

"var" or "par"
value

pass a numeric/integer value in R (NULL by default)
domain

domain of the int variable (NULL by default)

get ints

Description

Get a list of integer expressions

Usage

intExpressions(vals)

Arguments

vals

vector of integer values

int set declaration

Description

Declare a new set of int

Usage

IntSetDecl(name, kind, value = NULL)

Arguments

name

variable/parameter name
kind

"var" or "par"
value

provide an IntSetVal object (NULL by default)

Integer set value

Description

integer range set value in MiniZinc

Public fields

.min

minimum value of integer range

.max

maximum value of integer range

Active bindings

.min

minimum value of integer range

.max

maximum value of integer range

Methods

Public methods

Method new()

constructor

Usage
IntSetVal$new(imin, imax)
Arguments
imin

minimum int value

imax

maximum int value

Method getMin()

get the minimum IntVal

Usage
IntSetVal$getMin()

Method setMin()

set the minimum IntVal

Usage
IntSetVal$setMin(val)
Arguments
val

int value to be set

Method getMax()

get the maximum IntVal

Usage
IntSetVal$getMax()

Method setMax()

set the maximum IntVal

Usage
IntSetVal$setMax(val)
Arguments
val

int value to be set

Method clone()

The objects of this class are cloneable with this method.

Usage
IntSetVal$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

IntVal class (not exposed to user)

Description

create an Integer Value in MiniZinc

Public fields

.val

the integer value

Active bindings

.val

the integer value

Methods

Public methods

Method new()

constructor

Usage
IntVal$new(val)
Arguments
val

int value to be assigned

Method v()

return the value

Usage
IntVal$v()

Method clone()

The objects of this class are cloneable with this method.

Usage
IntVal$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Ite

Description

Create if-then-else expressions in MiniZinc

Super class

rminizinc::Expression -> Ite

Public fields

.ifs

list of if expressions

.thens

list of corresponding then expressions

.else

else expression

.delete_flag

used to delete items

Active bindings

.ifs

list of if expressions

.thens

list of corresponding then expressions

.else

else expression

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Ite$new(ifs, thens, Else)
Arguments
ifs

list of if expressions

thens

list of corresponding then expressions

Else

else expression

Method getIfs()

get the if expression list

Usage
Ite$getIfs()

Method getThens()

get the then expression list

Usage
Ite$getThens()

Method setIfsThens()

set the if and then expression list

Usage
Ite$setIfsThens(ifs, thens)
Arguments
ifs

expression list to be set

thens

expression list to be set

Method getIf()

get the ith if expression

Usage
Ite$getIf(i)
Arguments
i

index

Method setIf()

set the ith if expression

Usage
Ite$setIf(i, expIf)
Arguments
i

index

expIf

if expression to be set

Method getThen()

get the ith then expression

Usage
Ite$getThen(i)
Arguments
i

index

Method setThen()

set the ith then expression

Usage
Ite$setThen(i, expThen)
Arguments
i

index

expThen

then expression to be set

Method getElse()

get the else expression

Usage
Ite$getElse()

Method setElse()

get the else expression

Usage
Ite$setElse(expElse)
Arguments
expElse

else expression to be set

Method c_str()

get the MiniZinc representation

Usage
Ite$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Ite$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Ite$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Ite$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Item class (Abstract)

Description

Abstract class for all items in MiniZinc grammar

Methods

Public methods

Method new()

constructor

Usage
Item$new()

Method clone()

The objects of this class are cloneable with this method.

Usage
Item$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

search item in model and delete

Description

Find the object in the model and delete it.

Usage

itemDelete(classNm, model)

Arguments

classNm

object to be deleted
model

model to delete the object from

iterate through expressions and delete (Under Development)

Description

Given an object to delete and expression object, delete all the embedded expression objects that are identical

Usage

iterExpression(classNm, expObj)

Arguments

classNm

class name of the object to delete
expObj

expression object to iterate through

check all possible items(Under Development)

Description

Find the expressions in the items and delete them if matched

Usage

iterItem(mod, classNm)

Arguments

mod

model to be searched
classNm

class name of the object to be deleted

knapsack problem

Description

Solve a simple knapsack problem (Goal is to maximize the profit)

Usage

knapsack(n, capacity, profit, size)

Arguments

n

number of items
capacity

total capacity of carrying weight
profit

profit corresponding to each item
size

weight/size of each item

Let

Description

Create let expression in MiniZinc

Super class

rminizinc::Expression -> Let

Public fields

.decl

list of local declarations

.in

body of the let

.delete_flag

used to delete items

Active bindings

.decl

list of local declarations

.in

body of the let

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
Let$new(let, body)
Arguments
let

list of local declaration items and/or constraint items

body

body of the let

Method getLets()

access list of declaration items and/or constraint items

Usage
Let$getLets()

Method setLets()

set list of declaration items and/or constraint items

Usage
Let$setLets(letList)
Arguments
letList

list of declaration items and/or constraint items to be set

Method getLet()

access declaration item and/or constraint item i

Usage
Let$getLet(i)
Arguments
i

index of let declaration item and/or constraint item to be accessed

Method setLet()

set list of declaration item and/or constraint item i

Usage
Let$setLet(let)
Arguments
let

declaration item and/or constraint item to be set

Method getBody()

get the body

Usage
Let$getBody()

Method setBody()

set the body

Usage
Let$setBody(expBody)
Arguments
expBody

expression to be set for body

Method c_str()

get the MiniZinc representation

Usage
Let$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Let$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Let$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Let$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Absolute path of the libminizinc library

Description

Absolute path of the libminizinc library

Usage

LIBMINIZINC_PATH

Format

A string containing linker flag

magic series problem

Description

Solve a magic series problem in MiniZinc Model created by Hakan Kjellerstrand(hakank(at)bonetmail.com) See : http://www.hakank.org/minizinc/magic_series.mzn

Usage

magic_series(n)

Arguments

n

order of magic square

magic squares problem

Description

Solve a magic squares problem in MiniZinc Model created by Hakan Kjellerstrand(hakank(at)bonetmail.com) See : http://www.hakank.org/minizinc/magic_square.mzn

Usage

magic_square(n)

Arguments

n

order of magic square

MiniZinc Model class

Description

This class will take all the objects required to create a MiniZinc model.

Public fields

.items

list of items in the model

Active bindings

.items

list of items in the model

Methods

Public methods

Method new()

create a new instance of model class

Usage
Model$new(items)
Arguments
items

all items of the model

Method getItems()

get all the items

Usage
Model$getItems()

Method setItems()

set all the items

Usage
Model$setItems(items)
Arguments
items

items to be set

Method getItem()

get the item using index

Usage
Model$getItem(i)
Arguments
i

index

Method setItem()

set the item using index

Usage
Model$setItem(i, item)
Arguments
i

index

item

item to be set

Method addItem()

add item to the model

Usage
Model$addItem(item)
Arguments
item

item to add

Method nitems()

get the number of items

Usage
Model$nitems()

Method mzn_string()

get the string representation of the model

Usage
Model$mzn_string()

Method clone()

The objects of this class are cloneable with this method.

Usage
Model$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

MiniZinc model evaluation

Description

evaluates the MiniZinc model

Usage

mzn_eval(
  lib_path = "",
  r_model = NULL,
  mzn_path = "",
  model_string = "",
  solver = "org.gecode.gecode",
  dzn_path = "",
  all_solutions = TRUE,
  time_limit = 300000L,
  other_cl_options = NULL
)

Arguments

lib_path

the path of the library where the standard library files are present (the parent directory of the std directory).
r_model

R6 Model object
mzn_path

path of the mzn file to be solved
model_string

model string to be solved.
solver

the name of the solver to use.(default: Gecode)
dzn_path

path of the datafile to be used.
all_solutions

bool to specify if all solutions are specified.(default: true)
time_limit

stop after <time_limit> milliseconds. (default: 300000ms – 5 mins)
other_cl_options

other command line options/flags that you want to provide 1. Please provide as a character/string vector with each element as a flag 2. Incorrect flags or incorrect commands will throw errors. 3. Changing the default solution output options will result in parsing errors and the solutions will not be parsed correctly to R but the solution string will be returned.

MiniZinc syntax parser

Description

parses the MiniZinc syntax into R objects

Usage

mzn_parse(model_string = "", mzn_path = "", include_path = NULL)

Arguments

model_string

string representation of the MiniZinc model.
mzn_path

the path of model mzn.
include_path

path of the included mzn in the model if it exists.

production planning problem

Description

simple production planning problem taken from https://github.com/MiniZinc/minizinc-examples Goal is to maximize the profit

Usage

production_planning(
  nproducts,
  profit,
  pnames,
  nresources,
  capacity,
  rnames,
  consumption
)

Arguments

nproducts

number of different products
profit

profit for each product (1-D vector)
pnames

names of each product (1-D vector)
nresources

number of resources
capacity

amount of each resource available (1-D vector)
rnames

names of each resource (1-D vector)
consumption

units of each resource required to produce 1 unit of product (2-D vector to be provided as 1-D vector)

Absolute path of project directory

Description

Absolute path of project directory

Usage

PROJECT_DIRECTORY

Format

A string containing absolute path of the project directory

Set

Description

Create a set in MiniZinc

Super class

rminizinc::Expression -> Set

Public fields

.setVal

the value of the set

.isv

the integer range set

.fsv

the float range set

.et

empty set

.delete_flag

used to delete items

Active bindings

.setVal

the value of the set

.isv

the integer range set

.fsv

the float range set

.et

empty set

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constuctor

Usage
Set$new(val = NULL, empty_set = FALSE)
Arguments
val

the set value

empty_set

bool to specify is set is empty(FALSE by default)

Method getSetVec()

get the set expression

Usage
Set$getSetVec()

Method setSetVec()

set the set expression

Usage
Set$setSetVec(val)
Arguments
val

list of expressions

Method isEmpty()

is the set empty

Usage
Set$isEmpty()

Method makeEmpty()

make the set empty

Usage
Set$makeEmpty()

Method getIsv()

return the integer set range

Usage
Set$getIsv()

Method setIsv()

set the integer set range

Usage
Set$setIsv(val)
Arguments
val

integer set range

Method getFsv()

get the float set range

Usage
Set$getFsv()

Method setFsv()

set the float set range

Usage
Set$setFsv(val)
Arguments
val

float set range

Method c_str()

get the MiniZinc representation

Usage
Set$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
Set$getDeleteFlag()

Method delete()

delete the assignment item

Usage
Set$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
Set$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newIntSet = Set$new(val = IntSetVal$new(1,5))
newIntSet$c_str()
newIntSet$setIsv(IntSetVal$new(2,6))
newIntSet$c_str()
newFloatSet = Set$new(val = FloatSetVal$new(1.1,5.1))
newFloatSet$c_str()
newFloatSet$setFsv(FloatSetVal$new(1.2,4.1))

set missing parameters

Description

Assign values to parameters which don't have a value assigned yet.

Usage

set_params(model, modData)

Arguments

model

Model object
modData

list of the value objects to be assigned

parse the solution

Description

can parse the JSON solution of a model to return a list output

Usage

sol_parse(solutionString)

Arguments

solutionString

solution of the model as a string representation

SolveItem

Description

specify whether the optimization problem is a satisfaction, minimization or maximization problem and/or expression to maximize/minnimize and/or annotation

Super class

rminizinc::Item -> SolveItem

Public fields

.e

the expression to maximize or minimize

.st

the solve type

.ann

annotation of the solve type

.delete_flag

used to delete items

Active bindings

.e

the expression to maximize or minimize

.st

the solve type

.ann

annotation of the solve type

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

create an instance of specify_problem class

Usage
SolveItem$new(solve_type = NULL, e = NULL, ann = NULL, mzn_str = NULL)
Arguments
solve_type

satisfy, minimize or maximize

e

expression to minimize or maximize

ann

annotation

mzn_str

string representation of Solve Item

Method getExp()

get the expression (or NULL)

Usage
SolveItem$getExp()

Method getAnn()

get the annotation (or NULL)

Usage
SolveItem$getAnn()

Method setExp()

set the expression

Usage
SolveItem$setExp(e)
Arguments
e

expression

Method setAnn()

set the annotation

Usage
SolveItem$setAnn(ann)
Arguments
ann

annotation or Null

Method getSt()

get the solve type/objective

Usage
SolveItem$getSt()

Method setSt()

set the solve type/objective

Usage
SolveItem$setSt(objective)
Arguments
objective

solve type

Method c_str()

to string method

Usage
SolveItem$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
SolveItem$getDeleteFlag()

Method delete()

delete the variable item

Usage
SolveItem$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
SolveItem$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Absolute path of the solver executable directory

Description

Absolute path of the solver executable directory

Usage

SOLVER_BIN

Format

A string containing path of solver executable directory

String

Description

Create a string in MiniZinc

Super class

rminizinc::Expression -> String

Public fields

.value

string value

Active bindings

.value

string value

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
String$new(val)
Arguments
val

string input

Method getV()

get value

Usage
String$getV()

Method setV()

set value

Usage
String$setV(val)
Arguments
val

string value

Method c_str()

get the MiniZinc representation

Usage
String$c_str()

Method clone()

The objects of this class are cloneable with this method.

Usage
String$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newString = String$new("example")
newString$c_str()
newString$setV("new example")
newString$c_str()

n-D String array declaration

Description

Declare a new n-dimensional array of strings

Usage

StringArrDecl(name, kind, ind, value = NULL, ndim)

Arguments

name

variable/parameter name
kind

"var" or "par"
ind

index of the array
value

value (NULL by default)
ndim

number of dimensions of the array

get strings

Description

Get a list of string expressions

Usage

stringExpressions(vals)

Arguments

vals

vector of string values

set of string declaration

Description

declare a new set of string

Usage

StringSetDecl(name, kind, value = NULL)

Arguments

name

variable/parameter name
kind

"var" or "par"
value

provide a Set object (or NULL)

Type class

Description

The information of different data types

Public fields

.bt

the base type

.kind

parameter or decision

.dim

the number of dimensions set or plain

Active bindings

.bt

the base type

.kind

parameter or decision

.dim

the number of dimensions set or plain

Methods

Public methods

Method new()

constructor

Usage
Type$new(base_type, kind, dim = 0, set_type = FALSE)
Arguments
base_type

the base type

kind

parameter or decision

dim

the number of dimensions

set_type

set or plain

Method bt()

return the base type

Usage
Type$bt()

Method st()

return if it's set type

Usage
Type$st()

Method kind()

return the kind

Usage
Type$kind()

Method ndim()

return the number of dimensions

Usage
Type$ndim()

Method isInt()

check if it's an int

Usage
Type$isInt()

Method isFloat()

check if it's a float

Usage
Type$isFloat()

Method isBool()

check if it's a bool

Usage
Type$isBool()

Method isString()

check if it's a string

Usage
Type$isString()

Method isSet()

return if set in MiniZinc

Usage
Type$isSet()

Method isIntSet()

check if it's a set of int

Usage
Type$isIntSet()

Method isFloatSet()

check if it's a set of float

Usage
Type$isFloatSet()

Method isBoolSet()

check if it's a set of bool

Usage
Type$isBoolSet()

Method clone()

The objects of this class are cloneable with this method.

Usage
Type$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

TypeInst

Description

Create type instantiation with indices, etc.

Super class

rminizinc::Expression -> TypeInst

Public fields

.indExpr

the index expression

.domain

the domain of possible values to be taken

.type

the type information

Active bindings

.indExpr

the index expression

.domain

the domain of possible values to be taken

.type

the type information

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
TypeInst$new(type, indexExprVec = NULL, domain = NULL)
Arguments
type

type of declaration

indexExprVec

expression list of indices

domain

the domain of decision variables

Method getDomain()

get the variable domain

Usage
TypeInst$getDomain()

Method setDomain()

set the variable domain

Usage
TypeInst$setDomain(dom)
Arguments
dom

domain expression to be set

Method ranges()

return the index expression vector

Usage
TypeInst$ranges()

Method isArray()

check if it's an array

Usage
TypeInst$isArray()

Method type()

return the type information

Usage
TypeInst$type()

Method clone()

The objects of this class are cloneable with this method.

Usage
TypeInst$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

TypeInst$new(type = Type$new(base_type = "int", kind = "par" ,dim = 1), 
             domain = Set$new(IntSetVal$new(2,5)))

UnOp

Description

Unary operation expression in MiniZinc Possible unary operators are: "+", "-", "not"

Super class

rminizinc::Expression -> UnOp

Public fields

.args

list of expression arguments

.op

operator to be used

.delete_flag

used to delete items

Active bindings

.args

list of expression arguments

.op

operator to be used

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
UnOp$new(args, op)
Arguments
args

list of expressions

op

unary operator

Method nargs()

get the number of arguments

Usage
UnOp$nargs()

Method getArgs()

get all expression arguments

Usage
UnOp$getArgs()

Method setArgs()

set all expression arguments

Usage
UnOp$setArgs()
Arguments
args

argument list to be set

Method getArg()

get the ith expression argument

Usage
UnOp$getArg(i)
Arguments
i

index

Method setArg()

set the ith expression argument

Usage
UnOp$setArg(i, val)
Arguments
i

index

val

value of expression to be set

Method getOp()

get the unary operator

Usage
UnOp$getOp()

Method setOp()

set the unary operator

Usage
UnOp$setOp(unop)
Arguments
unop

unary operator to be set

Method c_str()

return the MiniZinc representation

Usage
UnOp$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
UnOp$getDeleteFlag()

Method delete()

delete the assignment item

Usage
UnOp$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
UnOp$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newUnOp = UnOp$new(args = list(Int$new(5)), op = "-")
newUnOp$c_str()
newUnOp$setArg(1, Int$new(6))
newUnOp$setOp("+")
newUnOp$c_str()

VarDecl

Description

Contains different fields to create a variable declaration

Super class

rminizinc::Expression -> VarDecl

Public fields

.ti

type instantiation information

id

name of the variable

.expression

the initialization expression

.delete_flag

used to delete items

Active bindings

.ti

type instantiation information

id

name of the variable

.expression

the initialization expression

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
VarDecl$new(name, type_inst, value = NULL)
Arguments
name

the identifier/name

type_inst

type instantiation of the variable

value

value of variable, NULL by default

Method getId()

get the identifier object

Usage
VarDecl$getId()

Method setId()

set the identifier object name

Usage
VarDecl$setId(name)
Arguments
name

name to be set

Method isPar()

check if it's a parameter

Usage
VarDecl$isPar()

Method isVar()

check if it's a decision variable

Usage
VarDecl$isVar()

Method setDomain()

overwrite the existing domain

Usage
VarDecl$setDomain(dom)
Arguments
dom

domain expression to be set

Method getDomain()

get the variable domain

Usage
VarDecl$getDomain()

Method getValue()

get the value

Usage
VarDecl$getValue()

Method setValue()

set the value

Usage
VarDecl$setValue(val)
Arguments
val

expression to be set (NULL to remove value)

Method ti()

get the type-inst of the variable declaration

Usage
VarDecl$ti()

Method c_str()

get the domain of the variable

return string representation of MiniZinc

Usage
VarDecl$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
VarDecl$getDeleteFlag()

Method delete()

delete the assignment item

Usage
VarDecl$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
VarDecl$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

newVarDecl = VarDecl$new(name = "n", 
type_inst = TypeInst$new(Type$new(base_type = "int", kind = "par")))
newVarDecl$c_str()

The variable declaration item

Description

Declaration items in the model

Super class

rminizinc::Item -> VarDeclItem

Public fields

.decl

the declaration expression

.delete_flag

used to delete items

Active bindings

.decl

the declaration expression

.delete_flag

used to delete items

Methods

Public methods

Inherited methods

Method new()

constructor

Usage
VarDeclItem$new(decl = NULL, mzn_str = NULL)
Arguments
decl

the declaration expression object

mzn_str

string representation of variable declaration item

Method getDecl()

get the variable declaration

Usage
VarDeclItem$getDecl()

Method setDecl()

set the variable declaration

Usage
VarDeclItem$setDecl(e)
Arguments
e

var decl expression

Method getId()

get the identifier object for the variable

Usage
VarDeclItem$getId()

Method c_str()

set the variable declaration

convert the declaration to String

Usage
VarDeclItem$c_str()

Method getDeleteFlag()

delete flag for internal use

Usage
VarDeclItem$getDeleteFlag()

Method delete()

delete the variable item

Usage
VarDeclItem$delete()

Method clone()

The objects of this class are cloneable with this method.

Usage
VarDeclItem$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

declare 0-D variable with domain

Description

Declare a 0 dimensional (int, float, bool or string) variable with domain

Usage

VarDomainDecl(name, dom)

Arguments

name

variable name
dom

domain