First commit

README

@@ -0,0 +1,67 @@
+************************************************************************
+*                                                                      *
+*                        [S]ampling [T]ool[K]it                        *
+*                                                                      *
+*                                © 2015                                *
+*                                                                      *
+************************************************************************
+
+
+1. Requirements
+2. Intallation
+3. Issues
+4. Dev Infos
+
+************************************************************************
+*     Requirements
+************************************************************************
+
+=== General ===
+ - cmake
+ - gcc
+ - boost
+
+
+=== Voronoi & delaunay computation ===
+ - cgal
+
+
+=== Fast fourier transform and GPU parallelization ===
+ - fftw
+
+
+=== Graphs file output ===
+ - libpng
+ - cairo (optional)
+
+
+=== Documentation ===
+ - doxygen
+ - graphViz
+
+
+
+************************************************************************
+*     Intallation
+************************************************************************
+
+=== Linux & Mac ===
+
+$> cmake .
+$> make
+$> sudo make install
+
+Optional :
+$> make doc
+
+
+************************************************************************
+*      Dev Infos
+************************************************************************
+
+=== Contributors ===
+
+Chronologically :
+ - Wachtel Florent
+ - Pilleboue Adrien
+ - Cathelin Gael

data/cmake/FindSTK.cmake

@@ -0,0 +1,7 @@
+set(STK_INCLUDE_DIR /usr/local/include)
+set(STK_LIBRARY_DIRS /usr/local/lib)
+
+set(STK_LIBRARIES stk)
+
+include(/usr/local/share/stk/cmake/STKCuda.cmake)
+include(/usr/local/share/stk/cmake/STKCairo.cmake)

data/cmake/disabled/STKCairo.cmake

@@ -0,0 +1 @@
+set(STK_CAIRO_ENABLED 0)

data/cmake/enabled/STKCairo.cmake

@@ -0,0 +1,6 @@
+if(${STK_OPT_CAIRO_DISABLE})
+	set(STK_CAIRO_ENABLED 0)
+else(${STK_OPT_CAIRO_DISABLE})
+	add_definitions(-DCAIRO_ENABLED)
+	set(STK_CAIRO_ENABLED 1)
+endif(${STK_OPT_CAIRO_DISABLE})

doc/doc.html

@@ -0,0 +1 @@
+./html/index.html

doc/naming-convention.txt

@@ -0,0 +1,27 @@
+=== Nom des variables ===
+
+m_name		Variables membre d'une classe
+i_name		Parametre de fonction en entrée
+o_name		Parametre de fonction en sortie
+ _name		Parametre de fonction en entrée/sortie
+  name		Autre variable
+
+functionName
+ClassName
+file-name
+
+__UnstableClassName
+__unstableFunctionName
+
+stk_cuFunctionName
+cu-filename.cu
+cu-filename.hpp
+
+/**
+ * @class ClassName
+ * Une description longue
+ * @brief Une description courte
+ * @param Description du paramètre
+ * @return fffffffffff
+ * @see fdfdssdff fsdfsdsdfs
+ */

doc/spec.pts.txt

@@ -0,0 +1,58 @@
+************************************************
+FIRST HEAD LINE
+************************************************
+
+pts1	{dim}	{type}	{boundaries}
+
+	dim : number of dimension
+	type : weight type
+		d : double
+		c : complex
+		i : integer
+		i : unsigned integer
+		n : no value
+	boundaries : n for normal, t for toroidal space
+
+************************************************
+SECOND HEAD LINE
+************************************************
+
+{dim1_Min}	{dim1_Max}	...	{dimN_Min}	{dimN_Max}
+
+	dim1_Min : Minimum position for the 1st dimension
+	dim1_Max : Minimum position for the 1st dimension
+	...
+	dimN_Min : Minimum position for the Nth dimension
+	dimN_Max : Minimum position for the Nth dimension
+
+************************************************
+VALUES
+************************************************
+
+One line of this format per point
+{dim1}	...	{dimN}	{value}
+
+	dim1 : position in dimension 1
+	...
+	dimN : position in dimension N
+	value : weight value. The format depend
+		of the data type specified in
+		the header
+
+
+************************************************
+Example
+************************************************
+
+#Two points in [0;1]x[0;1] with double weight
+pts1	2	d	n
+0	1	0	1
+0.1	0.2	3.14
+0.5	0.8	42.0
+
+#Three points in [0;256] with complex weight
+pts1	1	c	n
+0	256
+0	0.3333	0.6666
+127	-0.125	0.256
+255	-0.2	-0.2

doc/spec2.pts.txt

@@ -0,0 +1,79 @@
+************************************************
+FIRST HEAD LINE
+************************************************
+
+pts2	{dim}	{type}	{domain}
+
+	dim : number of dimension
+	type : weight type
+		d : double
+		c : complex
+		i : integer
+		i : unsigned integer
+		n : no value
+	domain : domain type
+		unit
+		unit-tor
+		rect
+		rect-tor
+		base
+		base-tor
+
+************************************************
+SECOND HEAD LINE
+************************************************
+
+domain description, only for :
+	rect
+	rect-tor
+	base
+	base-tor
+
+rect and rect-tor :
+{dim1_Min}	{dim1_Max}	...	{dimN_Min}	{dimN_Max}
+	dim1_Min : Minimum position for the 1st dimension
+	dim1_Max : Minimum position for the 1st dimension
+	...
+	dimN_Min : Minimum position for the Nth dimension
+	dimN_Max : Minimum position for the Nth dimension
+
+base and base-tor :
+{Ref_dim1} ... {Ref_dimN} {Base1_dim1} ... {Base1_dimN} ... {BaseN_dim1} ... {BaseN_dimN}
+	Ref_dim1 : Position of the base for the 1st dimension
+	...
+	Ref_dimN : Position of the base for the Nth dimension
+
+	...
+
+	BaseX_dimY : Value of the Yth dimension of the Xth vector of the base
+
+************************************************
+VALUES
+************************************************
+
+One line of this format per point
+{dim1}	...	{dimN}	{value}
+
+	dim1 : position in dimension 1
+	...
+	dimN : position in dimension N
+	value : weight value. The format depend
+		of the data type specified in
+		the header
+
+
+************************************************
+Example
+************************************************
+
+#Two points in [0;1]x[0;1] with double weight
+pts2	2	d	unit-tor
+0.1	0.2	3.14
+0.5	0.8	42.0
+
+#Three points in [0;256] with complex weight
+pts1	1	c	rect
+0	256
+0	0.3333	0.6666
+127	-0.125	0.256
+255	-0.2	-0.2

modules/FindCairo.cmake

@@ -0,0 +1,45 @@
+# $Id$
+# This module defines:
+# CAIRO_LIBRARY_DIRS
+# CAIRO_INCLUDE_DIRS
+
+FIND_PATH(CAIRO_INCLUDE_DIRS cairo.h
+	$ENV{CAIRODIR}/include/cairo
+	$ENV{CAIRODIR}/include
+	$ENV{CAIRODIR}
+	~/Library/Frameworks
+	/Library/Frameworks
+	/usr/include/cairo
+	/usr/local/include/cairo
+	/sw/include # Fink
+	/opt/local/include # DarwinPorts
+	/opt/csw/include # Blastwave
+	/opt/include
+)
+
+IF(WIN32)
+	SET(CAIRO_LIBRARIES "cairo.lib")
+ELSE(WIN32)
+	SET(CAIRO_LIBRARIES "cairo")
+ENDIF(WIN32)
+
+FIND_PATH(CAIRO_LIBRARY_DIRS ${LIBCAIRO}
+	$ENV{CAIRODIR}/lib
+	$ENV{CAIRODIR}
+	~/Library/Frameworks
+	/Library/Frameworks
+	/usr/local/lib
+	/usr/lib
+	/sw/lib
+	/opt/local/lib
+	/opt/csw/lib
+	/opt/lib
+	/usr/freeware/lib64
+)
+
+SET(CAIRO_FOUND "NO")
+
+IF(CAIRO_LIBRARY_DIRS AND CAIRO_INCLUDE_DIRS)
+	SET(CAIRO_FOUND "YES")
+ENDIF(CAIRO_LIBRARY_DIRS AND CAIRO_INCLUDE_DIRS)
+

modules/FindFFTW.cmake

@@ -0,0 +1,44 @@
+# FFTW_INCLUDE_DIR = fftw3.h
+# FFTW_LIBRARIES = libfftw3.a
+# FFTW_FOUND = true if FFTW3 is found
+
+IF(FFTW_INCLUDE_DIRS)
+FIND_PATH(FFTW_INCLUDE_DIR fftw3.h ${FFTW_INCLUDE_DIRS})
+FIND_LIBRARY(FFTW_LIBRARY fftw3 ${FFTW_LIBRARY_DIRS})
+ELSE(FFTW_INCLUDE_DIRS)
+# SET(TRIAL_PATHS
+# $ENV{FFTW_HOME}/include
+# /usr/include
+# /usr/local/include
+# /opt/include
+# /usr/apps/include
+# )
+#
+# SET(TRIAL_LIBRARY_PATHS
+# $ENV{FFTW_HOME}/lib
+# /usr/lib
+# /usr/local/lib
+# /opt/lib
+# /sw/lib
+# )
+#
+# FIND_PATH(FFTW_INCLUDE_DIR fftw3.h ${TRIAL_PATHS})
+# FIND_LIBRARY(FFTW_LIBRARY fftw3 ${TRIAL_LIBRARY_PATHS})
+SET(FFTW_INCLUDE_DIR /usr/local/include/)
+SET(FFTW_LIBRARIES fftw3)
+
+ENDIF(FFTW_INCLUDE_DIRS)
+
+SET(FFTW_FOUND FALSE)
+IF(FFTW_INCLUDE_DIR AND FFTW_LIBRARIES)
+MESSAGE(STATUS "FFTW_INCLUDE_DIR=${FFTW_INCLUDE_DIR}")
+MESSAGE(STATUS "FFTW_LIBRARIES=${FFTW_LIBRARIES}")
+SET(FFTW_FOUND TRUE)
+ENDIF()
+
+MARK_AS_ADVANCED(
+FFTW_INCLUDE_DIR
+FFTW_LIBRARIES
+FFTW_FOUND
+)
+