RhodeCode

SET(PACKAGE_NAME ${PROJECT_NAME})

SET(PACKAGE_VERSION ${PROJECT_VERSION})

SET(abs_top_srcdir ${PROJECT_SOURCE_DIR})

SET(abs_top_builddir ${PROJECT_BINARY_DIR})

CONFIGURE_FILE(

  ${PROJECT_SOURCE_DIR}/doc/Doxyfile.in

  ${PROJECT_BINARY_DIR}/doc/Doxyfile

  @ONLY

)

IF(DOXYGEN_EXECUTABLE AND PYTHONINTERP_FOUND AND GHOSTSCRIPT_EXECUTABLE)

  FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/)

  SET(GHOSTSCRIPT_OPTIONS -dNOPAUSE -dBATCH -q -dEPSCrop -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -sDEVICE=pngalpha)

  ADD_CUSTOM_TARGET(html

    COMMAND ${CMAKE_COMMAND} -E remove_directory gen-images

    COMMAND ${CMAKE_COMMAND} -E make_directory gen-images

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/bipartite_matching.png ${CMAKE_CURRENT_SOURCE_DIR}/images/bipartite_matching.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/bipartite_partitions.png ${CMAKE_CURRENT_SOURCE_DIR}/images/bipartite_partitions.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/connected_components.png ${CMAKE_CURRENT_SOURCE_DIR}/images/connected_components.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/edge_biconnected_components.png ${CMAKE_CURRENT_SOURCE_DIR}/images/edge_biconnected_components.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/grid_graph.png ${CMAKE_CURRENT_SOURCE_DIR}/images/grid_graph.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/node_biconnected_components.png ${CMAKE_CURRENT_SOURCE_DIR}/images/node_biconnected_components.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/nodeshape_0.png ${CMAKE_CURRENT_SOURCE_DIR}/images/nodeshape_0.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/nodeshape_1.png ${CMAKE_CURRENT_SOURCE_DIR}/images/nodeshape_1.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/nodeshape_2.png ${CMAKE_CURRENT_SOURCE_DIR}/images/nodeshape_2.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/nodeshape_3.png ${CMAKE_CURRENT_SOURCE_DIR}/images/nodeshape_3.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/nodeshape_4.png ${CMAKE_CURRENT_SOURCE_DIR}/images/nodeshape_4.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/planar.png ${CMAKE_CURRENT_SOURCE_DIR}/images/planar.eps

    COMMAND ${GHOSTSCRIPT_EXECUTABLE} ${GHOSTSCRIPT_OPTIONS} -r18 -sOutputFile=gen-images/strongly_connected_components.png ${CMAKE_CURRENT_SOURCE_DIR}/images/strongly_connected_components.eps

    COMMAND ${CMAKE_COMMAND} -E remove_directory html

    COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/scripts/bib2dox.py ${CMAKE_CURRENT_SOURCE_DIR}/references.bib >references.dox

    COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile

    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

  )

  SET_TARGET_PROPERTIES(html PROPERTIES PROJECT_LABEL BUILD_DOC)

  IF(UNIX)

    INSTALL(

      DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/

      DESTINATION share/doc/lemon/html

      COMPONENT html_documentation

    )

  ELSEIF(WIN32)

    INSTALL(

      DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/

      DESTINATION doc

      COMPONENT html_documentation

    )

  ENDIF()

ENDIF()

EXTRA_DIST += \

	doc/Doxyfile.in \

	doc/DoxygenLayout.xml \

	doc/coding_style.dox \

	doc/dirs.dox \

	doc/groups.dox \

	doc/lgf.dox \

	doc/license.dox \

	doc/mainpage.dox \

	doc/migration.dox \

	doc/min_cost_flow.dox \

	doc/named-param.dox \

	doc/namespaces.dox \

	doc/html \

	doc/CMakeLists.txt

DOC_EPS_IMAGES18 = \

	grid_graph.eps \

	nodeshape_0.eps \

	nodeshape_1.eps \

	nodeshape_2.eps \

	nodeshape_3.eps \

	nodeshape_4.eps

DOC_EPS_IMAGES27 = \

	bipartite_matching.eps \

	bipartite_partitions.eps \

	connected_components.eps \

	edge_biconnected_components.eps \

	node_biconnected_components.eps \

	planar.eps \

	strongly_connected_components.eps

DOC_EPS_IMAGES = \

	$(DOC_EPS_IMAGES18) \

	$(DOC_EPS_IMAGES27)

DOC_PNG_IMAGES = \

	$(DOC_EPS_IMAGES:%.eps=doc/gen-images/%.png)

EXTRA_DIST += $(DOC_EPS_IMAGES:%=doc/images/%)

doc/html:

	$(MAKE) $(AM_MAKEFLAGS) html

GS_COMMAND=gs -dNOPAUSE -dBATCH -q -dEPSCrop -dTextAlphaBits=4 -dGraphicsAlphaBits=4

$(DOC_EPS_IMAGES18:%.eps=doc/gen-images/%.png): doc/gen-images/%.png: doc/images/%.eps

	-mkdir doc/gen-images

	if test ${gs_found} = yes; then \

	  $(GS_COMMAND) -sDEVICE=pngalpha -r18 -sOutputFile=$@ $<; \

	else \

	  echo; \

	  echo "Ghostscript not found."; \

	  echo; \

	  exit 1; \

	fi

$(DOC_EPS_IMAGES27:%.eps=doc/gen-images/%.png): doc/gen-images/%.png: doc/images/%.eps

	-mkdir doc/gen-images

	if test ${gs_found} = yes; then \

	  $(GS_COMMAND) -sDEVICE=pngalpha -r27 -sOutputFile=$@ $<; \

	else \

	  echo; \

	  echo "Ghostscript not found."; \

	  echo; \

	  exit 1; \

	fi

references.dox: doc/references.bib

	if test ${python_found} = yes; then \

	  cd doc; \

	  python @abs_top_srcdir@/scripts/bib2dox.py @abs_top_builddir@/$< >$@; \

	  cd ..; \

	else \

	  echo; \

	  echo "Python not found."; \

	  echo; \

	  exit 1; \

	fi

html-local: $(DOC_PNG_IMAGES) references.dox

	if test ${doxygen_found} = yes; then \

	  cd doc; \

	  doxygen Doxyfile; \

	  cd ..; \

	else \

	  echo; \

	  echo "Doxygen not found."; \

	  echo; \

	  exit 1; \

	fi

clean-local:

	-rm -rf doc/html

	-rm -f doc/doxygen.log

	-rm -f $(DOC_PNG_IMAGES)

	-rm -rf doc/gen-images

update-external-tags:

	wget -O doc/libstdc++.tag.tmp http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/libstdc++.tag && \

	mv doc/libstdc++.tag.tmp doc/libstdc++.tag || \

	rm doc/libstdc++.tag.tmp

install-html-local: doc/html

	@$(NORMAL_INSTALL)

	$(mkinstalldirs) $(DESTDIR)$(htmldir)/html

	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \

	  f="`echo $$p | sed -e 's|^.*/||'`"; \

	  echo " $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/html/$$f"; \

	  $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/html/$$f; \

	done

uninstall-local:

	@$(NORMAL_UNINSTALL)

	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \

	  f="`echo $$p | sed -e 's|^.*/||'`"; \

	  echo " rm -f $(DESTDIR)$(htmldir)/html/$$f"; \

	  rm -f $(DESTDIR)$(htmldir)/html/$$f; \

	done

.PHONY: update-external-tags

\brief Algorithms for finding minimum cost flows and circulations.

This group contains the algorithms for finding minimum cost flows and

circulations \ref amo93networkflows. For more information about this

problem and its dual solution, see \ref min_cost_flow

"Minimum Cost Flow Problem".

LEMON contains several algorithms for this problem.

 - \ref NetworkSimplex Primal Network Simplex algorithm with various

   pivot strategies \ref dantzig63linearprog, \ref kellyoneill91netsimplex.

 - \ref CostScaling Cost Scaling algorithm based on push/augment and

   relabel operations \ref goldberg90approximation, \ref goldberg97efficient,

   \ref bunnagel98efficient.

 - \ref CapacityScaling Capacity Scaling algorithm based on the successive

   shortest path method \ref edmondskarp72theoretical.

 - \ref CycleCanceling Cycle-Canceling algorithms, two of which are

   strongly polynomial \ref klein67primal, \ref goldberg89cyclecanceling.

In general NetworkSimplex is the most efficient implementation,

but in special cases other algorithms could be faster.

For example, if the total supply and/or capacities are rather small,

CapacityScaling is usually the fastest algorithm (without effective scaling).

*/

/**

@defgroup min_cut Minimum Cut Algorithms

@ingroup algs

\brief Algorithms for finding minimum cut in graphs.

This group contains the algorithms for finding minimum cut in graphs.

The \e minimum \e cut \e problem is to find a non-empty and non-complete

\f$X\f$ subset of the nodes with minimum overall capacity on

outgoing arcs. Formally, there is a \f$G=(V,A)\f$ digraph, a

\f$cap: A\rightarrow\mathbf{R}^+_0\f$ capacity function. The minimum

cut is the \f$X\f$ solution of the next optimization problem:

\f[ \min_{X \subset V, X\not\in \{\emptyset, V\}}

    \sum_{uv\in A: u\in X, v\not\in X}cap(uv) \f]

LEMON contains several algorithms related to minimum cut problems:

- \ref HaoOrlin "Hao-Orlin algorithm" for calculating minimum cut

  in directed graphs.

- \ref NagamochiIbaraki "Nagamochi-Ibaraki algorithm" for

  calculating minimum cut in undirected graphs.

- \ref GomoryHu "Gomory-Hu tree computation" for calculating

  all-pairs minimum cut in undirected graphs.

If you want to find minimum cut just between two distinict nodes,

see the \ref max_flow "maximum flow problem".

*/

/**

@defgroup min_mean_cycle Minimum Mean Cycle Algorithms

@ingroup algs

\brief Algorithms for finding minimum mean cycles.

This group contains the algorithms for finding minimum mean cycles

\ref clrs01algorithms, \ref amo93networkflows.

The \e minimum \e mean \e cycle \e problem is to find a directed cycle

of minimum mean length (cost) in a digraph.

The mean length of a cycle is the average length of its arcs, i.e. the

ratio between the total length of the cycle and the number of arcs on it.

This problem has an important connection to \e conservative \e length

\e functions, too. A length function on the arcs of a digraph is called

conservative if and only if there is no directed cycle of negative total

length. For an arbitrary length function, the negative of the minimum

cycle mean is the smallest \f$\epsilon\f$ value so that increasing the

arc lengths uniformly by \f$\epsilon\f$ results in a conservative length

function.

LEMON contains three algorithms for solving the minimum mean cycle problem:

- \ref Karp "Karp"'s original algorithm \ref amo93networkflows,

  \ref dasdan98minmeancycle.

- \ref HartmannOrlin "Hartmann-Orlin"'s algorithm, which is an improved

  version of Karp's algorithm \ref dasdan98minmeancycle.

- \ref Howard "Howard"'s policy iteration algorithm

  \ref dasdan98minmeancycle.

In practice, the Howard algorithm proved to be by far the most efficient

one, though the best known theoretical bound on its running time is

exponential.

Both Karp and HartmannOrlin algorithms run in time O(ne) and use space

O(n<sup>2</sup>+e), but the latter one is typically faster due to the

applied early termination scheme.

*/

/**

@defgroup matching Matching Algorithms

@ingroup algs

\brief Algorithms for finding matchings in graphs and bipartite graphs.

This group contains the algorithms for calculating

matchings in graphs and bipartite graphs. The general matching problem is

finding a subset of the edges for which each node has at most one incident

edge.

There are several different algorithms for calculate matchings in

graphs.  The matching problems in bipartite graphs are generally

easier than in general graphs. The goal of the matching optimization

can be finding maximum cardinality, maximum weight or minimum cost

matching. The search can be constrained to find perfect or

maximum cardinality matching.

The matching algorithms implemented in LEMON:

- \ref MaxBipartiteMatching Hopcroft-Karp augmenting path algorithm

  for calculating maximum cardinality matching in bipartite graphs.

- \ref PrBipartiteMatching Push-relabel algorithm

  for calculating maximum cardinality matching in bipartite graphs.

- \ref MaxWeightedBipartiteMatching

  Successive shortest path algorithm for calculating maximum weighted

  matching and maximum weighted bipartite matching in bipartite graphs.

- \ref MinCostMaxBipartiteMatching

  Successive shortest path algorithm for calculating minimum cost maximum

  matching in bipartite graphs.

- \ref MaxMatching Edmond's blossom shrinking algorithm for calculating

  maximum cardinality matching in general graphs.

- \ref MaxWeightedMatching Edmond's blossom shrinking algorithm for calculating

  maximum weighted matching in general graphs.

- \ref MaxWeightedPerfectMatching

  Edmond's blossom shrinking algorithm for calculating maximum weighted

  perfect matching in general graphs.

*/

/**

@defgroup graph_properties Connectivity and Other Graph Properties

@ingroup algs

\brief Algorithms for discovering the graph properties

This group contains the algorithms for discovering the graph properties

like connectivity, bipartiteness, euler property, simplicity etc.

\image html connected_components.png

\image latex connected_components.eps "Connected components" width=\textwidth

*/

/**

@defgroup planar Planarity Embedding and Drawing

@ingroup algs

\brief Algorithms for planarity checking, embedding and drawing

This group contains the algorithms for planarity checking,

embedding and drawing.

\image html planar.png

\image latex planar.eps "Plane graph" width=\textwidth

*/

/**

@defgroup approx Approximation Algorithms

@ingroup algs

\brief Approximation algorithms.

This group contains the approximation and heuristic algorithms

implemented in LEMON.

*/

/**

@defgroup auxalg Auxiliary Algorithms

@ingroup algs

\brief Auxiliary algorithms implemented in LEMON.

This group contains some algorithms implemented in LEMON

in order to make it easier to implement complex algorithms.

*/

/**

@defgroup gen_opt_group General Optimization Tools

\brief This group contains some general optimization frameworks

implemented in LEMON.

This group contains some general optimization frameworks

implemented in LEMON.

*/

/**

@defgroup lp_group LP and MIP Solvers

@ingroup gen_opt_group

\brief LP and MIP solver interfaces for LEMON.

This group contains LP and MIP solver interfaces for LEMON.

Various LP solvers could be used in the same manner with this

high-level interface.

The currently supported solvers are \ref glpk, \ref clp, \ref cbc,

\ref cplex, \ref soplex.

*/

/**

@defgroup lp_utils Tools for Lp and Mip Solvers

@ingroup lp_group

\brief Helper tools to the Lp and Mip solvers.

This group adds some helper tools to general optimization framework

implemented in LEMON.

*/

/**

@defgroup metah Metaheuristics

@ingroup gen_opt_group

\brief Metaheuristics for LEMON library.

This group contains some metaheuristic optimization tools.

*/

/**

@defgroup utils Tools and Utilities

\brief Tools and utilities for programming in LEMON

Tools and utilities for programming in LEMON.

*/

/**

@defgroup gutils Basic Graph Utilities

@ingroup utils

\brief Simple basic graph utilities.

This group contains some simple basic graph utilities.

*/

/**

@defgroup misc Miscellaneous Tools

@ingroup utils

\brief Tools for development, debugging and testing.

This group contains several useful tools for development,

debugging and testing.

*/

/**

@defgroup timecount Time Measuring and Counting

@ingroup misc

\brief Simple tools for measuring the performance of algorithms.

This group contains simple tools for measuring the performance

of algorithms.

*/

/**

@defgroup exceptions Exceptions

@ingroup utils

\brief Exceptions defined in LEMON.

This group contains the exceptions defined in LEMON.

*/

/**

@defgroup io_group Input-Output

\brief Graph Input-Output methods