Little additional improvement of documentation of include/dai/util.h
[libdai.git] / Makefile
index 0c71239..7ff3579 100644 (file)
--- a/Makefile
+++ b/Makefile
-# Copyright (C) 2006-2009  Joris Mooij  [joris dot mooij at tuebingen dot mpg dot de]
-# Radboud University Nijmegen, The Netherlands /
-# Max Planck Institute for Biological Cybernetics, Germany
-#   
-# This file is part of libDAI.
+# This file is part of libDAI - http://www.libdai.org/
 #
-# libDAI is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
+# libDAI is licensed under the terms of the GNU General Public License version
+# 2, or (at your option) any later version. libDAI is distributed without any
+# warranty. See the file COPYING for more details.
 #
-# libDAI is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with libDAI; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-
-
-# Choose OS from {LINUX, WINDOWS, CYGWIN, MACOSX}
-# LINUX:   GNU/Linux and other UNIX variants
-# WINDOWS: Visual C++ with GNU Make
-# CYGWIN:  CygWin
-# MACOSX:  MacOSX
-OS=LINUX
-
-# Enable/disable various approximate inference methods
-WITH_BP=true
-WITH_MF=true
-WITH_HAK=true
-WITH_LC=true
-WITH_TREEEP=true
-WITH_JTREE=true
-WITH_MR=true
-WITH_GIBBS=true
-
-# Build with debug info?
-DEBUG=true
-
-# Build matlab interface?
-WITH_MATLAB=
-# New/old matlab version?
-NEW_MATLAB=true
-
-# Directories
-#   Location libDAI headers
-INC=include/dai
-#   Location of libDAI source files
-SRC=src
-#   Destination directory of libDAI library
-LIB=lib
-#   Additional iclude paths for C compiler
-CCINC=-Iinclude
-
-# Extensions (library, object, executable, matlab compiled MEX file)
-ifneq ($(OS),WINDOWS)
-  LE=.a
-  OE=.o
-  EE=
-  ME=.mexglx
-else
-  LE=.lib
-  OE=.obj
-  EE=.exe
-  ME=.mexglx
-endif
+# Copyright (C) 2006-2009  Joris Mooij  [joris dot mooij at libdai dot org]
+# Copyright (C) 2006-2007  Radboud University Nijmegen, The Netherlands
 
-# Libraries
-ifneq ($(OS),WINDOWS)
-  LIBS=-ldai
-  # Additional library paths for linker
-  CCLIB=-Llib
-else
-  # For some reason, we have to add the VC library path, although it is in the environment
-  LIBS=/link $(LIB)/libdai$(LE) /LIBPATH:"C:\Program Files\Microsoft Visual Studio 9.0\VC\ATLMFC\LIB" /LIBPATH:"C:\Program Files\Microsoft Visual Studio 9.0\VC\LIB" /LIBPATH:"C:\Program Files\Microsoft SDKs\Windows\v6.0A\lib"
-endif
 
-# Tell the linker to link with the BOOST Program Options library
-ifeq ($(OS),CYGWIN)
-  BOOSTLIBS=-lboost_program_options-gcc34-mt
-endif
-ifeq ($(OS),MACOSX)
-  BOOSTLIBS=-lboost_program_options-mt
-endif
-ifeq ($(OS),LINUX)
-  BOOSTLIBS=-lboost_program_options
-endif
-ifeq ($(OS),WINDOWS)
-  BOOSTLIBS=/LIBPATH:C:\boost_1_36_0\stage\lib
-endif
+# Load the local configuration from Makefile.conf
+include Makefile.conf
 
-# Compiler specific options
-ifneq ($(OS),WINDOWS)
-  # Compile using GNU C++ Compiler
-  CC=g++
-  # Output filename option of the compiler
-  CCO=-o 
-else
-  # Compile using Visual C++ Compiler
-  CC=cl
-  # Output filename option
-  CCO=/Fe
-endif
+# Directories of libDAI sources
+# Location libDAI headers
+INC=include/dai
+# Location of libDAI source files
+SRC=src
+# Destination directory of libDAI library
+LIB=lib
 
-# Flags for the C++ compiler
-ifneq ($(OS),WINDOWS)
-  CCFLAGS=-O3 -Wno-deprecated -Wall -W -Wextra -fpic
-  CCDEBUGFLAGS=-g -DDAI_DEBUG
+# Set final compiler flags
+ifdef DEBUG
+  CCFLAGS:=$(CCFLAGS) $(CCDEBUGFLAGS)
 else
-  CCFLAGS=/Iinclude /IC:\boost_1_36_0 /EHsc /Ox
-  CCDEBUGFLAGS=/Zi -DDAI_DEBUG
+  CCFLAGS:=$(CCFLAGS) $(CCNODEBUGFLAGS)
 endif
 
-ifeq ($(OS),CYGWIN)
-  CCINC:=$(CCINC) -I/usr/local/include/boost-1_37
-  # dynamic linking of Boost libraries seems not to work on Cygwin
-  CCFLAGS:=$(CCFLAGS) -DCYGWIN -static
+# Define build targets
+TARGETS=tests utils lib examples testregression testem
+ifdef WITH_DOC
+  TARGETS:=$(TARGETS) doc
 endif
-ifeq ($(OS),MACOSX)
-  # indicate where your boost headers and libraries are (likely where macports installs libraries)
-  CCINC:=$(CCINC) -I/opt/local/include
-  CCLIB:=$(CCLIB) -L/opt/local/lib
-endif
-
-# Build targets
-TARGETS=tests utils $(LIB)/libdai$(LE) examples testregression
-ifneq ($(OS),WINDOWS)
-  TARGETS:=$(TARGETS) doc 
-endif
-
 ifdef WITH_MATLAB
+  TARGETS:=$(TARGETS) matlabs
+  # Specify the same C++ compiler and flags to mex
   ifneq ($(OS),WINDOWS)
-    # Replace the following by the directory where Matlab has been installed
-    MATLABDIR=/agbs/share/sw/matlab
-    MEX=$(MATLABDIR)/bin/mex
     MEXFLAGS=CXX\#$(CC) CXXFLAGS\#'$(CCFLAGS)'
   else
-    # Replace the following by the directory where Matlab has been installed
-    MATLABDIR=c:\matlab
-    MEX=$(MATLABDIR)\bin\mex
-    MEXFLAGS=-Iinclude CXX\#$(CC) CXXFLAGS\#"/EHsc /Ox"
+    MEXFLAGS=CXX\#$(CC) CXXFLAGS\#"$(CCFLAGS)"
   endif
-endif
-
-
-ifdef DEBUG
-  CCFLAGS:=$(CCFLAGS) $(CCDEBUGFLAGS)
-endif
-ifeq ($(OS),WINDOWS)
-  CCFLAGS:=$(CCFLAGS) -DWINDOWS
-endif
-ifdef WITH_MATLAB
-  TARGETS:=$(TARGETS) matlabs
   ifdef NEW_MATLAB
     MEXFLAGS:=$(MEXFLAGS) -largeArrayDims
   else
@@ -160,8 +46,8 @@ ifdef WITH_MATLAB
   endif
 endif
 
-
-OBJECTS:=exactinf$(OE)
+# Define conditional build targets
+OBJECTS:=exactinf$(OE) evidence$(OE) emalg$(OE)
 ifdef WITH_BP
   CCFLAGS:=$(CCFLAGS) -DDAI_WITH_BP
   OBJECTS:=$(OBJECTS) bp$(OE)
@@ -194,12 +80,21 @@ ifdef WITH_GIBBS
   CCFLAGS:=$(CCFLAGS) -DDAI_WITH_GIBBS
   OBJECTS:=$(OBJECTS) gibbs$(OE)
 endif
+ifdef WITH_CBP
+  CCFLAGS:=$(CCFLAGS) -DDAI_WITH_CBP
+  OBJECTS:=$(OBJECTS) bbp$(OE) cbp$(OE) bp_dual$(OE)
+endif
 
+# Define standard libDAI header dependencies
+HEADERS=$(INC)/bipgraph.h $(INC)/index.h $(INC)/var.h $(INC)/factor.h $(INC)/varset.h $(INC)/smallset.h $(INC)/prob.h $(INC)/daialg.h $(INC)/properties.h $(INC)/alldai.h $(INC)/enum.h $(INC)/exceptions.h $(INC)/util.h
 
-HEADERS=$(INC)/bipgraph.h $(INC)/index.h $(INC)/var.h $(INC)/factor.h $(INC)/varset.h $(INC)/smallset.h $(INC)/prob.h $(INC)/daialg.h $(INC)/properties.h $(INC)/alldai.h $(INC)/enum.h $(INC)/exceptions.h
-
-
-CC:=$(CC) $(CCINC) $(CCLIB) $(CCFLAGS)
+# Setup final command for C++ compiler and MEX
+ifneq ($(OS),WINDOWS)
+  CC:=$(CC) $(CCINC) $(CCFLAGS) $(CCLIB)
+else
+  CC:=$(CC) $(CCINC) $(CCFLAGS)
+  LIBS:=$(LIBS) $(CCLIB)
+endif
 MEX:=$(MEX) $(CCLIB) $(CCINC) $(MEXFLAGS)
 
 
@@ -208,14 +103,16 @@ MEX:=$(MEX) $(CCLIB) $(CCINC) $(MEXFLAGS)
 
 all : $(TARGETS)
 
-examples : examples/example$(EE) examples/example_bipgraph$(EE) examples/example_varset$(EE) examples/example_sprinkler$(EE)
+examples : examples/example$(EE) examples/example_bipgraph$(EE) examples/example_varset$(EE) examples/example_permute$(EE) examples/example_sprinkler$(EE)
 
 matlabs : matlab/dai$(ME) matlab/dai_readfg$(ME) matlab/dai_writefg$(ME) matlab/dai_potstrength$(ME)
 
-tests : tests/testdai$(EE)
+tests : tests/testdai$(EE) tests/testem/testem$(EE) tests/testbbp$(EE)
 
 utils : utils/createfg$(EE) utils/fg2dot$(EE) utils/fginfo$(EE)
 
+lib: $(LIB)/libdai$(LE)
+
 
 # OBJECTS
 ##########
@@ -232,6 +129,15 @@ exactinf$(OE) : $(SRC)/exactinf.cpp $(INC)/exactinf.h $(HEADERS)
 bp$(OE) : $(SRC)/bp.cpp $(INC)/bp.h $(HEADERS)
        $(CC) -c $(SRC)/bp.cpp
 
+bp_dual$(OE) : $(SRC)/bp_dual.cpp $(INC)/bp_dual.h $(HEADERS)
+       $(CC) -c $(SRC)/bp_dual.cpp
+
+bbp$(OE) : $(SRC)/bbp.cpp $(INC)/bbp.h $(INC)/bp_dual.h $(HEADERS)
+       $(CC) -c $(SRC)/bbp.cpp
+
+cbp$(OE) : $(SRC)/cbp.cpp $(INC)/cbp.h $(INC)/bbp.h $(INC)/bp_dual.h $(HEADERS)
+       $(CC) -c $(SRC)/cbp.cpp
+
 lc$(OE) : $(SRC)/lc.cpp $(INC)/lc.h $(HEADERS)
        $(CC) -c $(SRC)/lc.cpp
 
@@ -268,6 +174,12 @@ mr$(OE) : $(SRC)/mr.cpp $(INC)/mr.h $(HEADERS)
 gibbs$(OE) : $(SRC)/gibbs.cpp $(INC)/gibbs.h $(HEADERS)
        $(CC) -c $(SRC)/gibbs.cpp
 
+evidence$(OE) : $(SRC)/evidence.cpp $(INC)/evidence.h $(HEADERS)
+       $(CC) -c $(SRC)/evidence.cpp
+
+emalg$(OE) : $(SRC)/emalg.cpp $(INC)/emalg.h $(INC)/evidence.h $(HEADERS)
+       $(CC) -c $(SRC)/emalg.cpp
+
 properties$(OE) : $(SRC)/properties.cpp $(HEADERS)
        $(CC) -c $(SRC)/properties.cpp
 
@@ -290,6 +202,9 @@ examples/example_bipgraph$(EE) : examples/example_bipgraph.cpp $(HEADERS) $(LIB)
 examples/example_varset$(EE) : examples/example_varset.cpp $(HEADERS) $(LIB)/libdai$(LE)
        $(CC) $(CCO)examples/example_varset$(EE) examples/example_varset.cpp $(LIBS)
 
+examples/example_permute$(EE) : examples/example_permute.cpp $(HEADERS) $(LIB)/libdai$(LE)
+       $(CC) $(CCO)examples/example_permute$(EE) examples/example_permute.cpp $(LIBS)
+
 examples/example_sprinkler$(EE) : examples/example_sprinkler.cpp $(HEADERS) $(LIB)/libdai$(LE)
        $(CC) $(CCO)examples/example_sprinkler$(EE) examples/example_sprinkler.cpp $(LIBS)
 
@@ -299,6 +214,11 @@ examples/example_sprinkler$(EE) : examples/example_sprinkler.cpp $(HEADERS) $(LI
 
 tests/testdai$(EE) : tests/testdai.cpp $(HEADERS) $(LIB)/libdai$(LE)
        $(CC) $(CCO)tests/testdai$(EE) tests/testdai.cpp $(LIBS) $(BOOSTLIBS)
+tests/testem/testem$(EE) : tests/testem/testem.cpp $(HEADERS) $(LIB)/libdai$(LE)
+       $(CC) $(CCO)$@ $< $(LIBS) $(BOOSTLIBS)
+
+tests/testbbp$(EE) : tests/testbbp.cpp $(HEADERS) $(LIB)/libdai$(LE)
+       $(CC) $(CCO)tests/testbbp$(EE) tests/testbbp.cpp $(LIBS)
 
 
 # MATLAB INTERFACE
@@ -350,16 +270,22 @@ endif
 # REGRESSION TESTS
 ###################
 
-ifneq ($(OS),WINDOWS)
 testregression : tests/testdai$(EE)
        @echo Starting regression test...this can take a minute or so!
+ifneq ($(OS),WINDOWS)
        cd tests && ./testregression && cd ..
 else
-testregression : tests/testdai$(EE)
-       @echo Starting regression test...this can take a minute or so!
        cd tests && testregression.bat && cd ..
 endif
 
+testem : tests/testem/testem$(EE)
+       @echo Starting EM tests
+ifneq ($(OS),WINDOWS)
+       cd tests/testem && ./runtests && cd ../..
+else
+       cd tests\testem && runtests && cd ..\..
+endif
+
 
 # DOCUMENTATION
 ################
@@ -367,6 +293,10 @@ endif
 doc : $(INC)/*.h $(SRC)/*.cpp examples/*.cpp doxygen.conf
        doxygen doxygen.conf
 
+TAGS:
+       etags src/*.cpp include/dai/*.h tests/*.cpp utils/*.cpp
+       ctags src/*.cpp include/dai/*.h tests/*.cpp utils/*.cpp
+
 
 # CLEAN
 ########
@@ -376,13 +306,13 @@ ifneq ($(OS),WINDOWS)
 clean :
        -rm *$(OE)
        -rm matlab/*$(ME)
-       -rm examples/example$(EE) examples/example_bipgraph$(EE) examples/example_varset$(EE) examples/example_sprinkler$(EE)
-       -rm tests/testdai$(EE)
+       -rm examples/example$(EE) examples/example_bipgraph$(EE) examples/example_varset$(EE) examples/example_permute$(EE) examples/example_sprinkler$(EE)
+       -rm tests/testdai$(EE) tests/testem/testem$(EE) tests/testbbp$(EE)
        -rm utils/fg2dot$(EE) utils/createfg$(EE) utils/fginfo$(EE)
        -rm -R doc
        -rm -R lib
 else
 .PHONY : clean
 clean :
-       -del *$(OE) *.ilk *.pdb *$(EE) matlab\*$(ME) examples\*$(EE) examples\*.ilk examples\*.pdb tests\testdai$(EE) tests\*.pdb tests\*.ilk utils\*$(EE) utils\*.pdb utils\*.ilk $(LIB)\libdai$(LE)
+       -del *$(OE) *.ilk *.pdb *$(EE) matlab\*$(ME) examples\*$(EE) examples\*.ilk examples\*.pdb tests\testdai$(EE) tests\testem\testem$(EE) tests\*.pdb tests\*.ilk utils\*$(EE) utils\*.pdb utils\*.ilk $(LIB)\libdai$(LE)
 endif