diff --git a/MD5 b/MD5 deleted file mode 100644 index c35ad3dac8dada0ed39d4598e746bf2ac240586e..0000000000000000000000000000000000000000 --- a/MD5 +++ /dev/null @@ -1,85 +0,0 @@ -aed7f2b6574917b3d0ca688429b99065 *DESCRIPTION -5daa14e3ff7a2270d741a3e781a8f987 *NAMESPACE -00cd81844a47cfe6b42a5b2139d64c78 *R/clp.R -3ce8923439c8c1b6b9d5a5b73eedc8c1 *R/clpAPI.R -9732448f604c10e494f1786df44f0a62 *R/clp_ptrClass.R -c28b18176d42d49363a806c626389214 *R/generics.R -b92329cf50a482f5a473bcce316e5669 *R/zzz.R -f7372a571a1b0690bfaf3bdb7b88c829 *build/vignette.rds -661848692617a4273bc42814dec96764 *cleanup -011ce44bdb6c566923d3f8473620a42a *configure -c2209e4bff9ea976398c3587f4e13c38 *configure.ac -d41d8cd98f00b204e9800998ecf8427e *configure.win -ee6ae0f4273773b869f135cdc41a6ef1 *inst/INSTALL -eb15b4cad6eef59a4ae92d53a44c24d0 *inst/NEWS.Rd -e236783da143c26d795f14dd8021f981 *inst/README -3952b2754f409d0fe85d390817441d03 *inst/c2r.map -1e514bbcc73c999233af23fb78ae0f9a *inst/doc/clpAPI.R -f932b68cee56631e482786a0e888fe45 *inst/doc/clpAPI.Rnw -e9350415f9796cedd430ddbae49d06e8 *inst/doc/clpAPI.pdf -6bb5e918e9243fc4d2404ae81576bf20 *man/addColsCLP.Rd -3d7fc83d95f88caacb91ba6a894db11a *man/addRowsCLP.Rd -ae29b572c5b913e0cee58e41f9c1a77b *man/chgColLowerCLP.Rd -87cc07301c3cad4431b6a7a916787f93 *man/chgColUpperCLP.Rd -3998d99207a7c1260723825664df6133 *man/chgObjCoefsCLP.Rd -6bfa51e7bb325ac428f9270a028c8f7a *man/chgRowLowerCLP.Rd -633054b25943786817eebc3642183c1c *man/chgRowUpperCLP.Rd -84c9bba40b1ddfe90954903ce1fd3f6d *man/clpAPI-package.Rd -49d588eb46fcebee1712674bb4f7d3aa *man/clpPtr-class.Rd -fcf3a7ff8b53a3ec50c958c3d2166ca3 *man/copyNamesCLP.Rd -659504f9c06c120f6c55517d63bf4994 *man/delColsCLP.Rd -045ae82acdc295785959fd1e8db6cf5a *man/delProbCLP.Rd -9c1d261b4d7a3e3b4375fe8e75cedf39 *man/delRowsCLP.Rd -9cabdc8298f7370c21e15b513a0c7ca1 *man/dropNamesCLP.Rd -012d88d845f835bfe2cfea4ba08a6e3d *man/dualCLP.Rd -278341a1d5c00b1dbc8d7701ae0b8d86 *man/getColDualCLP.Rd -a6d90e81c179278dbf6086646af4a366 *man/getColLowerCLP.Rd -36a0fd7a47f52c73d59e82fd5857110d *man/getColPrimCLP.Rd -80d47275b11ba6c766b7b164e411d0fc *man/getColUpperCLP.Rd -f2f2fcd4e3c90634ab136b4627ae4b08 *man/getIndCLP.Rd -68a872b9c42e981c3317f8f965af541f *man/getLogLevelCLP.Rd -9162f07ae7aea48973cd93e1ee018d3e *man/getNnzCLP.Rd -81f39e9aa5747819fd1f87f8a1c36d21 *man/getNumColsCLP.Rd -fe178eb36ee4084fa25e21e56b04be92 *man/getNumNnzCLP.Rd -e43df9658e7fbe8c631349bdc06c73ea *man/getNumRowsCLP.Rd -7c577badd12b83de9afff5287619018b *man/getObjCoefsCLP.Rd -faa9ce206e630ab2d33cfa7b3d3d9117 *man/getObjDirCLP.Rd -4d8cc7aa9d96418f85633255fcf2867f *man/getObjValCLP.Rd -869b586c8026d2ec8e703ea761d6630e *man/getRowDualCLP.Rd -8212e338fbed580675f023fc6c477d3c *man/getRowLowerCLP.Rd -c943286578d76fbf3761b0a30c7fecd4 *man/getRowPrimCLP.Rd -57c2faa7f4443187dab2649912ed7688 *man/getRowUpperCLP.Rd -72df7fd600abfc56ce19a11f84842402 *man/getScaleFlagCLP.Rd -7b57d27e7160f754119e62a428ba27f3 *man/getSolStatusCLP.Rd -fd66b1d0be60b2c2855c93bfebd584ff *man/getVecLenCLP.Rd -4ae77953b088288d8b5c9c88e0e83446 *man/getVecStartCLP.Rd -8f8ecad322db363f477c83c35fc09603 *man/idiotCLP.Rd -6551a8a960f4462b59c34cdce1103161 *man/initProbCLP.Rd -f38b36396c9aaf39189b160c40167b65 *man/lengthNamesCLP.Rd -21aaec1dccf7fadd698c3da90bfd8d35 *man/loadMatrixCLP.Rd -70b15fb57229f15409b540663e81c4fc *man/loadProblemCLP.Rd -b52e0947a60ff6f1839a37d224a7a3df *man/primalCLP.Rd -a01c1ad1bfac218ad53b3c3abf90a2e2 *man/printModelCLP.Rd -a418a1cbfec3f1bdd4acf49f32f7b2e2 *man/probNameCLP.Rd -13cbb298a95e03c13e895dcd72c7147b *man/readMPSCLP.Rd -9870599290752fe1f5fbb51515c88151 *man/resizeCLP.Rd -dc8d186dbdf094fb26aef82502d4871b *man/restoreModelCLP.Rd -8f39cfcdbc1a927b83a8f1897865ed78 *man/return_codeCLP.Rd -ebdf498e2559a65c19729a1a21c9e72b *man/saveModelCLP.Rd -ff95f14cb153143c4addab443ab162c0 *man/scaleModelCLP.Rd -e04ef106322792a2c83721d6cf20e0dd *man/setLogLevelCLP.Rd -7411687c9940b4d378325078af8355c3 *man/setObjDirCLP.Rd -cd6ee2d6da156be2d3b7938d1d787a87 *man/solveInitialBarrierCLP.Rd -40bce1c1ba932f49b7b77b16b7210cb7 *man/solveInitialBarrierNoCrossCLP.Rd -c49b476f94cfbfbeb8a93a8bc7083d0f *man/solveInitialCLP.Rd -46cd2ee701fcdac1c2473b1072336e2d *man/solveInitialDualCLP.Rd -f89b721b6ec8b260fe3cdb7024932030 *man/solveInitialPrimalCLP.Rd -5724c8b0b98b6cf1bcc15bad70f87f5a *man/status_codeCLP.Rd -fa89b81b2935b875d4230c3e2c1c2e25 *man/versionCLP.Rd -e4cff70c399a10f65c797ddb9bfc2f65 *src/Makevars.in -5e18cdf60e85c6ed074a9125868cef8d *src/Makevars.win -80e01a59b216fbb14dd6b3b7aaa0f506 *src/clpAPI.c -ebf775ae8f5797658db56f2e81349c14 *src/clpAPI.h -f1ee63eab916e1506cb4af5fbcdddd5e *src/clpR.h -2f0955cfb67608368cf62466a9d2226f *src/init.c -f932b68cee56631e482786a0e888fe45 *vignettes/clpAPI.Rnw diff --git a/build/vignette.rds b/build/vignette.rds deleted file mode 100644 index 9b3d47b9fee20a56b8653f9b47f7d2a1babf978d..0000000000000000000000000000000000000000 Binary files a/build/vignette.rds and /dev/null differ diff --git a/inst/doc/clpAPI.R b/inst/doc/clpAPI.R deleted file mode 100644 index 3dac6b3aa4eb2ce0a25bb2b2c21fd198e7d287cf..0000000000000000000000000000000000000000 --- a/inst/doc/clpAPI.R +++ /dev/null @@ -1,127 +0,0 @@ -### R code from vignette source 'clpAPI.Rnw' -### Encoding: UTF-8 - -################################################### -### code chunk number 1: clpAPI.Rnw:74-75 -################################################### -library(clpAPI) - - -################################################### -### code chunk number 2: clpAPI.Rnw:78-79 -################################################### -prob <- initProbCLP() - - -################################################### -### code chunk number 3: clpAPI.Rnw:82-83 -################################################### -setObjDirCLP(prob, -1) - - -################################################### -### code chunk number 4: clpAPI.Rnw:86-88 -################################################### -nc <- 3 -nr <- 3 - - -################################################### -### code chunk number 5: clpAPI.Rnw:92-93 -################################################### -ia <- c(0, 1, 2, 0, 1, 2, 0, 1, 2) - - -################################################### -### code chunk number 6: clpAPI.Rnw:96-97 -################################################### -ja <- c(0, 3, 6, 9) - - -################################################### -### code chunk number 7: clpAPI.Rnw:100-101 -################################################### -ar <- c(2, 4, 3, 3, 1, 4, 1, 2, 2) - - -################################################### -### code chunk number 8: clpAPI.Rnw:104-105 -################################################### -clb <- rep(0, 3) - - -################################################### -### code chunk number 9: clpAPI.Rnw:108-109 -################################################### -rub <- c(5, 11, 8) - - -################################################### -### code chunk number 10: clpAPI.Rnw:112-113 -################################################### -obj <- c(5, 4, 3) - - -################################################### -### code chunk number 11: clpAPI.Rnw:116-117 -################################################### -loadProblemCLP(prob, nc, nr, ia, ja, ar, clb, NULL, obj, NULL, rub) - - -################################################### -### code chunk number 12: clpAPI.Rnw:120-121 -################################################### -solveInitialCLP(prob) - - -################################################### -### code chunk number 13: clpAPI.Rnw:124-125 -################################################### -getObjValCLP(prob) - - -################################################### -### code chunk number 14: clpAPI.Rnw:129-130 -################################################### -getColPrimCLP(prob) - - -################################################### -### code chunk number 15: clpAPI.Rnw:134-135 -################################################### -getColDualCLP(prob) - - -################################################### -### code chunk number 16: clpAPI.Rnw:138-139 -################################################### -delProbCLP(prob) - - -################################################### -### code chunk number 17: clpAPI.Rnw:154-155 -################################################### -help("Clp_addColumns") - - -################################################### -### code chunk number 18: clpAPI.Rnw:165-167 -################################################### -c2r <- system.file(package = "clpAPI", "c2r.map") -source(c2r) - - -################################################### -### code chunk number 19: clpAPI.Rnw:170-172 -################################################### -pr1 <- initProbCLP() -delProbCLP(pr1) - - -################################################### -### code chunk number 20: clpAPI.Rnw:175-177 -################################################### -pr2 <- Clp_newModel() -Clp_deleteModel(pr2) - - diff --git a/inst/doc/clpAPI.Rnw b/inst/doc/clpAPI.Rnw deleted file mode 100644 index c1bf50b28847f3bc53b47e394ed157ac367438ca..0000000000000000000000000000000000000000 --- a/inst/doc/clpAPI.Rnw +++ /dev/null @@ -1,183 +0,0 @@ -\documentclass[a4paper,headings=small]{scrartcl} -\usepackage[english]{babel} -\usepackage[T1]{fontenc} -\usepackage[latin1]{inputenc} -\usepackage{textcomp,lmodern} -\typearea[current]{last} -\usepackage{fixltx2e,mparhack,mathdots} - -\usepackage{natbib} -\usepackage{hyperref} -\bibliographystyle{abbrvnat} - -\usepackage{microtype} - - -\newcommand{\Comp}[1]{\texttt{#1}} - -\addtolength{\skip\footins}{0.5\baselineskip} - -\usepackage{fnpos} - - -\hypersetup{ - pdftitle = {clpAPI -- Quick Start}, - pdfauthor = {Gabriel Gelius-Dietrich}, - pdfsubject = {R Interface to C API of COIN-OR Clp}, - pdfkeywords = {Optimization, COIN-OR Clp}, - pdfborder = {0 0 0}, - pdfhighlight = {/N} -} - - -\newcommand{\pkg}[1]{\emph{#1}} -\newcommand{\pkgname}{\pkg{clpAPI}} -\newcommand{\prgname}[1]{\textsc{#1}} - - -\begin{document} -\title{clpAPI -- Quick Start} -%\VignetteIndexEntry{Package clpAPI -- Quick Start} -\author{Gabriel Gelius-Dietrich} - -\maketitle - -\section{Introduction} -The package \pkgname{} provides a low level interface to the C~API of -COIN-OR Clp\footnote{COIN-OR linear programming version 1.12.0 or higher -\url{https://projects.coin-or.org/Clp}} (COIN-OR linear programming). -The package \pkgname{} relies on a separate installation of COIN-OR Clp. - -\section{Installation} -See \Comp{INSTALL} for installation instructions and platform specific details. - -\section{Usage} - -In the following, an example lp-problem will be created and solved: - -\noindent -\hspace{.5in} maximize -$$z = 5 x_1 + 4 x_2 + 3 x_3$$ -\hspace{.5in} subject to -$$ -\begin{array}{r@{\:}c@{\:}r@{\:}c@{\:}r@{\:}c@{\:}r} -2 x_1 &+& 3 x_2 &+& x_3 & \leq 5 \\ -4 x_1 &+& x_2 &+& 2 x_3 & \leq 11 \\ -3 x_1 &+& 4 x_2 &+& 2 x_3 & \leq 8 \\ -\end{array} -$$ -\hspace{.5in} where all variables are non-negative -$$x_1 \geq 0, \ x_2 \geq 0, \ x_3 \geq 0$$ - -\noindent -Load the library. -<<>>= -library(clpAPI) -@ -Create a problem object. -<<>>= -prob <- initProbCLP() -@ -Set the direction of optimization ($-1$: maximize, $1$: minimize). -<<>>= -setObjDirCLP(prob, -1) -@ -Prepare data structures for the problem object. Number of columns and rows: -<<>>= -nc <- 3 -nr <- 3 -@ -The constraint matrix is passed in column major order format. \textbf{Be -careful here:} all indices start with 0! Row indices. -<<>>= -ia <- c(0, 1, 2, 0, 1, 2, 0, 1, 2) -@ -Column indices. -<<>>= -ja <- c(0, 3, 6, 9) -@ -Non-zero elements. -<<>>= -ar <- c(2, 4, 3, 3, 1, 4, 1, 2, 2) -@ -Lower bounds for the variables (columns). -<<>>= -clb <- rep(0, 3) -@ -Right hand side (row upper bounds for the rows). -<<>>= -rub <- c(5, 11, 8) -@ -Objective coefficients. -<<>>= -obj <- c(5, 4, 3) -@ -Load problem data into the problem object. -<<>>= -loadProblemCLP(prob, nc, nr, ia, ja, ar, clb, NULL, obj, NULL, rub) -@ -Solve the problem using the simplex algorithm. -<<>>= -solveInitialCLP(prob) -@ -Retrieve the value of the objective function after optimization. -<<>>= -getObjValCLP(prob) -@ -Retrieve the primal values of the structural variables (columns) after -optimization. -<<>>= -getColPrimCLP(prob) -@ -Retrieve the dual values of the structural variables (columns) after -optimization (reduced costs). -<<>>= -getColDualCLP(prob) -@ -Free memory, allacated to the problem object. -<<>>= -delProbCLP(prob) -@ - - -\section{Function names} - -\subsection{Searching} - -The function names in \pkgname{} are different from the names in -\prgname{COIN-OR Clp}, -e.\,g. the function \texttt{addColsCLP} in \pkgname{} is called -\texttt{Clp\_addColumns} in \prgname{COIN-OR Clp}. The directory \texttt{inst/} -containes a file \texttt{c2r.map} which maps a \prgname{COIN-OR Clp} function -name to the corresponding \pkgname{} function name. Additionally, all man-pages -contain an alias to the \prgname{COIN-OR Clp} function name. The call -<<>>= -help("Clp_addColumns") -@ -will bring up the man-page of \texttt{addColsCLP}. - - -\subsection{Mapping} - -The file \texttt{c2r.map} in \texttt{inst/} maps the \pkgname{} function names -to the orininal \prgname{COIN-OR Clp} function names of its C-API. -To use the latter, run -<<>>= -c2r <- system.file(package = "clpAPI", "c2r.map") -source(c2r) -@ -now either -<<>>= -pr1 <- initProbCLP() -delProbCLP(pr1) -@ -or the original functions -<<>>= -pr2 <- Clp_newModel() -Clp_deleteModel(pr2) -@ -work both. Keep in mind that the mapping only affects the function names not the -arguments of a function. - - -\end{document}