source: releases/5.6.5/README.md

Last change on this file was 2352, checked in by tkr, 3 years ago

Merging r2351 from trunk

  • Property svn:eol-style set to native
File size: 18.2 KB
Line 
1# SYMPHONY Version 5.6.5 README
2
3Welcome to SYMPHONY. SYMPHONY is distributed under the Eclipse Public License
4and is freely redistributable. All source code and documentation is Copyright
52000-2014 by Ted Ralphs and others. This README may be redistributed freely.
6
7#DOCUMENTATION
8
9If you have downloaded a source distribution, LaTex source for the full documentation is available in the SYMPHONY/Doc/ subdirectory. Quick start guides and pointers to other on-line documentation can be found at the project Wiki:
10
11https://projects.coin-or.org/SYMPHONY
12
13The on-line version of the manual is available here:
14
15http://www.coin-or.org/SYMPHONY/man-5.6/
16
17What follows is a very brief and possibly out-of-date quick summary of
18installation and usage. Please see the documentation for more details.
19
20## INSTALLATION
21
22If you downloaded a source distribution and would like instructions on
23building SYMPHONY or you downloaded a binary distribution and would like to
24know how to install it, please see the INSTALL file.
25
26## USING SYMPHONY
27
28### Using SYMPHONY from the command line
29
30To use SYMPHONY as a generic solver, type the executable name on the command
31line, followed by one or more of the command-line switches. On the
32command-line, there is one required switch---you must specify the location of
33the input file by using either "-F 'filename'" (MPS file or automatic
34detection with file extension) or "-L 'filename'" (LP format). If the "-D"
35switch is also present, the file will be assumed to be a GMPL model file with
36the data file specified after the "-D" switch. In LINUX, the following command
37would solve the instance "sample.mps"
38
39```symphony -F sample.mps```
40
41The remaining switches are used to set SYMPHONY's native parameters on the
42command line. Below is a list of these parameters. This list can also be
43obtained by executng
44
45```symphony -h```
46
47Note that all SYMPHONY parameters are denoted by a lowercase letter. Many
48other parameters can be set with the use of a parameter file (specified with
49-f). These parameters are listed in the SYMPHONY user's manual.
50
51```
52symphony [ -FL file ] [ -f parameter_file_name ]
53        [ -hd ] [-a 0/1] [-b 0/1 ] [-s cands] [-l 0/1] [ -q 0/1 ] [ -r 0/1]
54        [-j 0/1 ] [ -e n ] [ -i iters ] [ -t time ] [ -g gap ] [ -n nodes ]
55        [ -u ub ] [ -p procs ] [ -k rule ] [ -v level ] [ -c rule ]
56        [ -m max ] [ -z n ] [-o tree_out_file]
57
58
59        -F model: model should be read in from file 'model'
60                  (MPS format is assumed unless -D is also present)
61        -L model: LP format model should be read in from file 'model'
62        -D data: model is in AMPL format and data is in file 'data'
63        -T dir: run test with MIPLIB3 models
64        -h: help
65        -f file: read parameters from parameter file 'file'
66        -d: stop at first feasible solution
67        -a 0/1: whether to use primal heuristics
68        -b 0/1: whether to use reliability branching
69        -s cands: use at most 'cands' candidates for strong branching
70        -l 0/1: whether to impose a limit on strong branching time
71        -q 0/1: whether or not to tighten root bounds
72        -r 0/1: whether or not to do reduced cost tightening
73        -j 0/1: whether or not to generate cgl cuts
74        -e n: set pre-processing level to 'n'
75        -i iters: allow a max of 'iters' iterations in presolve
76        -t time: set wallclock time limit to 'time'
77        -g gap: set gap limit to 'gap'
78        -n nodes: set node limit to 'nodes'
79        -u ub: use initial upper bound 'ub'
80        -p procs: allow 'procs' additional threads or processors
81        -k i: use node selection rule 'i'
82        -v n: set verbosity to level 'n'
83        -c i: use rule 'i' to compare candidates
84        -m max: allow a max of 'max' cuts to enter per iteration
85        -z n: set diving threshold to 'n'
86        -o file: output vbc-like tree information to file 'file'
87```
88               
89### Using the SYMPHONY interactive optimizer
90
91To use SYMPHONY's Interactive shell, run the executable name without any
92command line arguments. Then type "help" or "?" to see a list of available
93commands which are as follows for this version:
94
95```
96        load      : read a problem in mps or ampl format
97        solve     : solve the problem
98        lpsolve   : solve the lp relaxation of the problem
99        set       : set a parameter
100        display   : display optimization results and stats
101        reset     : restart the optimizer
102        help      : show the available commands/params/options 
103
104        quit/exit : leave the optimizer
105```
106       
107So, if you want to load and solve an ampl/gmpl file, you will need to type
108"load sample.mod sample.dat" and then "solve".
109
110### Using the callable library
111
112To use SYMPHONY as a generic callable library, compile SYMPHONY as described
113above. The library that is created along with the solver itself can be linked
114to using the API described in the user's manual. For examples of using the
115callable library in this way, see the Examples/ subdirectory.
116
117## DEVELOPING CUSTOM APPLICATIONS
118
119To customize SYMPHONY by implementing the custom callback functions, simply
120modify the files in the SYMPHONY/Applications/USER/ subdirectory, as described
121in the user's manual and follow the compilation procedures in the file
122SYMPHONY/Applications/USER/README. There are a number of sample applications
123available as examples of how to do this kind of development with SYMPHONY.
124These include solvers for the matching problem, the set partitioning problem
125(simple and advanced versions), the vehicle routing and traveling salesman
126problems, and the mixed postman problem. These applications are distributed as
127separate packages and can be downloaded from http://www.branchandcut.org.
128There is a white paper that guides the user through the development of the
129matching solver.
130
131## CURRENT TESTING STATUS
132
133SYMPHONY can now be used in a very large number of possible configurations and
134we simply aren't able to test them all. Below is a rough idea of the testing
135status of various configurations to date. If you need a certain configuration,
136I would be happy to help you get it running. Please let me know.
137
138## LP INTERFACES
139
140**The native interfaces for OSL and CPLEX have now been deprecated**
141**Only LP solvers with OSI interfaces are supported**
142
143Well tested: CPLEX, CLP
144
145Well tested, but have some stability or other issues: GLPK
146
147Compiled, but not well tested: SPX
148
149## TESTED CONFIGURATIONS
150
151### SEQUENTIAL
152
153Known configurations that build and pass unit test
154
155- gcc 4.* on LINUX
156- MSVC++ Version 9-11 compiler in CYGWIN using the autotools
157- MSVC++ Version 9-11 IDE
158- gcc 4.* on Mac OSX 10.4.8
159- clang
160
161### SHARED MEMORY PARLLEL (OpenMP)
162
163Builds and passes unit test with gcc 4.* and CLP on LINUX.
164
165### DISTRIBUTED MEMORY PARALLEL (PVM)
166
167Known configurations that build and pass unit test
168
169- gcc 4.* on LINUX with PVM 3.4
170
171### APPLICATIONS
172
173- SYMPHONY (used as a generic MILP solver): Well tested.
174
175- MATCH (matching): Tested, but not very extensively.
176
177- MPP (mixed postman problem): Tested, but not very extensively.
178
179- VRP (vehicle routing problem): Well tested.
180
181- CNRP (capacitates network routing problem): Well tested.
182
183- MCKP (multi criteria knapsack problem): Well tested.
184
185- SPP (set partitioning problem): Tested, but not very extensively.
186
187- SPP+CUTS (set partitioning problem with cutting planes): Tested, but not very
188extensively.
189
190### CUT GENERATORS
191
192Cut generators are supplied by the Cut Generation Library (CGL). The cut
193generators that are turned on by default have been well tested. Two cut
194generators that are part ofthe CGL are turned off by default because of known
195issues. These are lift and project cuts and the simple rounding cuts. The
196generator for Gomory cuts works well, but has somenumerical issues. We found a
197few cases where the optimal solution was not found when using the Gomory cut
198generator, especially in combination with CPLEX. If the solver is not
199performing as it should, try turning off some of the cut generators to see if
200that fixes the problem.
201
202### EXTERNAL COIN-OR LIBRARIES
203
204See the Depdencies file for a list of the external COIN-OR libraries on which
205SYMPHONY depends.
206
207## SUPPORT
208
209### LIST SERVE
210
211There is a list serve for SYMPHONY users. To subscribe, go to
212http://list.coin-or.org/mailman/listinfo/coin-symphony
213
214### AUTHORS
215
216SYMPHONY was jointly developed by Ted Ralphs (ted@lehigh.edu) and Laci Ladanyi
217(ladanyi@us.ibm.com). Menal Guzelsoy (menal.guzelsoy@gmail.com) and Ashutosh
218Mahajan (amahajan@iitb.ac.in.edu) have been instrumental in development since
219version 5.0.
220
221### BUG REPORTS
222
223To report a bug please file a ticket at
224
225https://projects.coin-or.org/SYMPHONY/newticket
226
227Please note the version of SYMPHONY you are using when filing the ticket.
228
229## WHAT'S NEW
230
231Release 5.6.5:
232
2331. Added explicit dependence on libgomp, which is needed for linking with
234compilers that don't supprt OpenMP (clang on OS X)
235
236Release 5.6.4:
237
2381. Fix to pkgconfig file to add flags for OpenMP.
239
2402. Fixes for documentation.
241
2423. More fixes for dependency linking.
243
244Release 5.6.3:
245
2461. Fixes to applications to allow some preprocessing, which is needed for
247some primal heuristics to work.
248
2492. Fixes to preprocessor settings so that the minimal amount of preprocessing
250is always done.
251
2523. Fixes to some methods so they still work preprely even when preprocessing is
253not done.
254
2554. Fixes to pre-processor for applications that construct the LP relaxation
256algorithmically.
257
2585. Fix to pkgconfig file for applications.
259
2606. Fix for dependency linking.
261
2627. Other small bug fixes.
263
264Release 5.6.2:
265
2661. Updates and fixes to manual and documentation files.
267
2682. Fixes for configuring with PVM.
269
2703. Fixes to allow dependency linking with the application library.
271
2724. Bug fix for reliability branching.
273
2745. Bug fix for addition of column cuts
275
2766. Updates to externals to fix bugs in dependent projects.
277
278Release 5.6.1:
279
2801. Small fixes for OpenMP
281
282Release 5.6.0:
283
2841. Major re-design of shared memory parallel mode for increased efficiency and stability.
285
2862. Fixes for distributed memory parallel version (PVM)
287
2883. Fixes for bicriteria version
289
290Release 5.5.7:
291
2921. More updates to build harness
293
294Release 5.5.6:
295
2961. More updates to build harness
297
298Release 5.5.5:
299
3001. More updates to build harness
301
302Release 5.5.4:
303
3041. Fix memory leak
3052. Delete superfluous header file
3063. More updates to build harness
307
308Release 5.5.3:
309
3101. More updates to build harness
311
312Release 5.5.2:
313
3141. Fix problems with Visual Studio project files
3152. Update to build tools
316
317Release 5.5.1:
318
3191. Fix bug that caused all user applications to crash
320
321Release 5.4.8:
322
3231. Updates to MSVC++ files (applications now use property sheets and VRP app file is fixed).
3242. Other fixes for build tools.
325
326Release 5.4.7:
327
3281. Updates to documentation
329
330Release 5.5.0:
331
3321. Improvements to preprocessing
3332. Improvements to heuristics
3343. Improvements to MSVC++ support
3354. Bug fixes
3365. Significant performance gains
337
338Release 5.4.6:
3391. More fixes to allow use of CPLEX as LP solver
3402. Fixes to interface with GMPL
341
342Release 5.4.5:
343
3441. Fixes to allow use of CPLEX as LP solver
3452. Fixes to interface with GMPL
346
347Release 5.4.4:
348
3491. Fixes for build system
3502. Other minor fixes
351
352Release 5.4.3:
353
3541. Updates to documentation.
3552. Fix to allow box-constrained integer programs.
3563. Fix for GMPL integration
3574. Fix for readline versions
358
359Release 5.4.2:
360
3611. Updates to MSVC++ version 10 files
362
363Release 5.4.1
364
3651. Addition of MSVC++ version 9 files
366
367Release 5.4.0:
368
3691. Change license to EPL.
370
3712. Support for MSVC++ version 10 added.
372
3733. Support for BuildTools version 0.7 to incoorporate recent enhancements, including proper library versioning in Linux, prohibiting installation of private headers, etc.
374
3754. Enhancements to unit testing.
376
3775. Updating externals to new stable versions of dependent projects.
378
379Release 5.3.4:
380
3811. Fixes to the shared memory parallel version (OpenMP). It is now pretty
382stable, though some minor memory conflict conditions may arise (infrequently).
383
3842. Fixes to allow all applications to build and run properly.
385
3863. Updates to documentation.
387
388Release 5.3.3:
389
3901. Fixes to the build system.
391
392Release 5.3.2:
393
3941. Fixes to the build system.
395
396Release 5.3.1:
397
3981. Fixes to the build system.
399
400Release 5.3.0:
401
4021. Major changes to the build system to allow buinding against installed
403binaries, provide pkg-config support, etc.
404
405Release 5.2.4:
406
4071. Fixes to restore functionality of the bicriteria solution capability.
408
4092. Fixes to examples.
410
411Release 5.2.3:
412
4131. Updates to manual.
414
4152. Added hooks to enable the use of VRPH (https://projects.coin-or.org/VRPH) within the VRP solver.
416
417Release 5.2.2:
418
4191. Bug fix release.
420
421Release 5.2.1:
422
4231. Bug fix release.
424
425Release 5.2.0:
426
4271. SYMPHONY has a preprocessor now.
428
4292. Feasibility pump primal heuristic implemented.
430
4313. Reliability branching is now the default branching strategy.
432
4334. Several new statistics now part of default output.
434
4355. Correct setting of granularity of objective function value by calculating
436   GCD of coefficients.
437
4386. Several changes in management of valid inequalities, quality checks and
439   detection of duplicacy.
440
4417. Minor changes in management of LP solver interface.
442
4438. Several small bug-fixes and improvements.
444
445Release 5.1.10:
446
4471. New dependencies.
448
449Release 5.1.9:
450
4511. New dependencies.
452
453Release 5.1.8:
454
4551. Introduced use of LP hot starting.
456
4572. Improved management of cut generation.
458
4593. Updated externals
460
4614. Minor bug fixes
462
463Release 5.1.7:
464
4651. Minor bug fixes
466
467Release 5.1.6:
468
4691. Only a single header file (symphony.h) needs to be installed and user
470applications only need to be able to find this one header file.
471
4722. Fixes to MSVC++ project files.
473
4743. Removed dependence on qsortucb routines.
475
476Release 5.1.5:
477
4781. Added support for automatic download and build of Glpk (for reading of GMPL
479files).
480
4812. Minor bugs fixed and compiler warnings eliminated.
482
4833. Updates to MS Visual Studio files.
484
4854. Added short installation verification test.
486
487Release 5.1.4:
488
4891. Added ability to read files in LP format.
490
4912. Additional configuration options.
492
4933. Support for new classes of cutting planes.
494
4954. Improved algorithm control mechanism.
496
4975. Improved output format and additional output options.
498
4996. Improved signal handling.
500
5017. Shared memory parallel version tested with OpenMP in Linux and Windows.
502
5038. Added release configuration to MSVC++ build files.
504
5059. Improved warm starting.
506
50710. Fixes for configuration with SoPlex and Xpress.
508
50911. Fixed configuration on PowerPC architectures.
510
511Release 5.1.3:
512
5131. Support for building static executables in Unix-like environments.
514
5152. Improved signal-catching behavior in Unix-like environments.
516
5173. Updated documentation.
518
519Release 5.1.2:
520
5211. Update of externals.
522
5232. Updated documentation.
524
525Release 5.1.1:
526
5271. Fixes for building in the Solaris operating system.
528
5292. Fixes for using the GNU autotools to build with the cl compiler.
530
5312. Fixes for sym.mak file in order to allow building with MSVC++ nmake utility.
532
5334. Fixes for building the unit test in the MSVC++ IDE.
534
5355. Updated documentation
536
537Release 5.1.0:
538
5391. SYMPHONY now has an interactive optimizer that can be used through a
540command shell. In both the sequential and parallel configurations, the user
541can set parameters, load and solve instances interactively, and display
542results and statistics (see below).
543
5442. SYMPHONY now supports automatic configuration using the new COIN-OR build
545system and the GNU autotools.Using autotools utilities, it is now possible to
546build SYMPHONY in most operating systems and with most common compilers
547compilers without user intervention.
548
5493. Both the distributed and shared memory parallel configurations are now
550fully debugged, tested, and supported. The user can now build and execute
551custom SYMPHONY applications in parallel, as well as solving generic MILPs in
552parallel "out of the box."
553
5544. There are now additional options for warm starting. The user can trim the
555warm starting tree before starting to resolve a problem. More specifically,
556the user can decide to initiate warm starting with a predefined partition of
557the final branch-and-cut tree resulting from a previous solution procedure.
558This partition can include either a number of nodes created first during the
559solution procedure or all of the nodes above a given level of the tree.
560
5615. The COIN-OR repository, the current host of SYMPHONY has recently undergone
562some significant improvements of its own that have resulted in improved
563services to users. These include:
564
565-- SYMPHONY has a new development Web site, where users can submit trouble
566  tickets, browse the source code interactively, and get up-to-date
567  information on development. The address of the new site is
568  https://projects.coin-or.org/SYMPHONY.
569
570-- SYMPHONY is now hosted using subversion, a version control system with
571  features vastly improved over CVS, the previous hosting software. This has
572  required some reorganization and renaming of the header files.
573
574-- SYMPHONY is now more tightly integrated with other COIN-OR projects. Due
575  to improved procedures for producing stable releases, it will now be much
576  easier for us to determine the exact version of SYMPHONY and all other COIN
577  projects you are using when you report a bug.
578
579-- SYMPHONY is now distributed with all COIN software needed to build a
580  complete solver. Previously, other COIN softrware packages had to be
581  downloaded and installed separately.
582
583Two features have been deprecated and are no longer supported:
584
5851. The native interfaces to OSL and CPLEX are now deprecated and no longer
586supported. These solvers can be called through the COIN-OR OSI interface.
587
5882. Column generation functionality has also been officially deprecated. For
589now, there are a number of other software packages that offer better
590functionality than SYMPHONY for implementing branch and price algorithms.
591
592CHANGES TO THE USER INTERFACE (FROM SYMPHONY 5.0)
593=================================================
594
5951. There was one minor change to the user callback API from version 5.0 to 5.1.
596The user can now execute a primal heuristic in the user_is_feasible() callback
597and return the solution to SYMPHONY. The API for the user_is_feasible()
598subroutine is now
599
600int user_is_feasible(void *user, double lpetol, int varnum, int *indices,
601                     double *values, int *feasible, double *objval,
602                     char branching, double *heur_solution)
603
604Any feasible solution can be passed (in dense format) through the last
605argument to this function.
606
6072. Several new subroutines were added to the callable library API.
608
6093. The name of the header file containing the SYMPHONY API has been changed
610from "symphony_api.h" to "symphony.h" (though the former has been retained for
611backword compatibility purposes).
612
Note: See TracBrowser for help on using the repository browser.