ceci est un test

.travis.yml

@@ -0,0 +1,26 @@
+language: cpp
+sudo: false
+
+
+addons:
+    apt:
+        sources:
+            - llvm-toolchain-precise-3.5
+            - ubuntu-toolchain-r-test
+        packages:
+            - g++-5
+            - clang-3.5
+            - libgmp-dev
+            - libmpfr-dev
+
+env:
+    - NFL_CXX=g++-5 NFL_OPTIMIZED=ON
+    - NFL_CXX=g++-5 NFL_OPTIMIZED=OFF
+    - NFL_CXX=clang++-3.5 NFL_OPTIMIZED=ON
+    - NFL_CXX=clang++-3.5 NFL_OPTIMIZED=OFF
+
+script:
+    - git clone https://github.com/USCiLab/cereal
+    - cmake . -DNFL_OPTIMIZED=$NFL_OPTIMIZED -DCMAKE_CXX_COMPILER=$NFL_CXX -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$PWD/install -DCEREAL_PREFIX=$PWD/cereal
+    - make && make test ARGS="-VV" && make install
+

CMakeCompilers.txt

@@ -0,0 +1,34 @@
+include(CheckCXXCompilerFlag)
+
+# C++11 support
+CHECK_CXX_COMPILER_FLAG(-std=c++11 COMPILER_SUPPORTS_CXX11)
+if(COMPILER_SUPPORTS_CXX11)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+else()
+    CHECK_CXX_COMPILER_FLAG(-std=c++0x COMPILER_SUPPORTS_CXX0X)
+    if(COMPILER_SUPPORTS_CXX0X)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x")
+    else()
+        message(STATUS "The compiler ${CMAKE_CXX_COMPILER} has no C++11 support. Please use a different C++ compiler.")
+    endif()
+endif()
+
+# optimization flags support
+if(CMAKE_BUILD_TYPE MATCHES Release)
+	set(CMAKE_CXX_FLAGS_RELEASE "-DNDEBUG -O3")
+	foreach(FLAG -march=native -mtune=native -funroll-loops)
+		string(REGEX REPLACE -= _ FLAG_ID ${FLAG})
+		string(TOUPPER ${FLAG_ID} FLAG_ID)
+		CHECK_CXX_COMPILER_FLAG(${FLAG} COMPILER_SUPPORTS${FLAG_ID})
+	    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} ${FLAG}")
+	endforeach()
+else()
+    add_definitions(-DCHECK_STRICTMOD)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
+endif()
+
+if(APPLE)
+   set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -Wa,-q")
+endif()
+
+

CMakeLists.txt

@@ -0,0 +1,67 @@
+cmake_minimum_required(VERSION 2.8)
+project(nfl CXX ASM-ATT)
+enable_testing()
+if(APPLE)
+    cmake_policy(SET CMP0042 NEW)
+endif()
+
+option(NFL_OPTIMIZED "Build an optimized version of NFL" OFF)
+if(NFL_OPTIMIZED)
+    message(STATUS "Tring to use optimized version of NFL")
+    add_definitions(-DNFL_OPTIMIZED)
+
+    include(CheckCXXSourceCompiles)
+    set(CMAKE_CXX_FLAGS_OLD ${CMAKE_CXX_FLAGS})
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=native")
+
+    check_cxx_source_compiles("#include <immintrin.h>\nint main() { return 0;}" NFLLIB_USE_AVX)
+    check_cxx_source_compiles("#include <pmmintrin.h>\nint main() { return 0;}" NFLLIB_USE_SSE)
+    if(NFLLIB_USE_AVX)
+        message(STATUS "Using AVX vector engine")
+        add_definitions(-DNTT_AVX2)
+    elseif(NFLLIB_USE_SSE)
+        message(STATUS "Using SSE vector engine")
+        add_definitions(-DNTT_SSE)
+    else()
+        message(ERROR "Asking for optimized mode but neither SSE not AVX support detected")
+    endif()
+endif()
+
+include(CMakeCompilers.txt)
+
+
+set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
+find_package(GMP REQUIRED)
+find_package(MPFR REQUIRED)
+
+include_directories(include include/nfl include/nfl/arch include/nfl/opt include/nfl/opt/arch include/nfl/prng)
+
+
+file(GLOB NFLLIB_ASMS lib/prng/*.s)
+file(GLOB NFLLIB_SRCS lib/prng/*.cpp lib/params/*.cpp)
+file(GLOB NFLLIB_HDRS_0 include/nfl.hpp)
+file(GLOB NFLLIB_HDRS_1 include/nfl/*.hpp)
+file(GLOB NFLLIB_HDRS_2 include/nfl/arch/*.hpp)
+file(GLOB NFLLIB_HDRS_3 include/nfl/opt/*.hpp)
+file(GLOB NFLLIB_HDRS_4 include/nfl/opt/arch/*.hpp)
+file(GLOB NFLLIB_PRNG_HDRS include/nfl/prng/*.hpp include/nfl/prng/*.h)
+
+# shared library
+add_library(nfllib SHARED ${NFLLIB_ASMS} ${NFLLIB_SRCS})
+target_link_libraries(nfllib ${GMP_LIBRARY} ${MPFR_LIBRARY})
+install(TARGETS nfllib LIBRARY DESTINATION lib)
+
+# static library
+add_library(nfllib_static STATIC ${NFLLIB_ASMS} ${NFLLIB_SRCS})
+target_link_libraries(nfllib_static ${GMP_LIBRARY} ${MPFR_LIBRARY})
+install(TARGETS nfllib_static ARCHIVE DESTINATION lib)
+
+install(FILES ${NFLLIB_} DESTINATION include)
+install(FILES ${NFLLIB_HDRS_0} DESTINATION include)
+install(FILES ${NFLLIB_HDRS_1} DESTINATION include/nfl)
+install(FILES ${NFLLIB_HDRS_2} DESTINATION include/nfl/arch)
+install(FILES ${NFLLIB_HDRS_3} DESTINATION include/nfl/opt)
+install(FILES ${NFLLIB_HDRS_4} DESTINATION include/nfl/opt/arch)
+install(FILES ${NFLLIB_PRNG_HDRS} DESTINATION include/nfl/prng)
+
+add_subdirectory(tests)

MIT_LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright (c) 2016, Carlos Aguilar-Melchor, Serge Guelton, Adrien Guinet, Tancrède Lepoint
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

README.md

@@ -1,18 +1,59 @@
 # NFLlib
-NTT-based Fast Lattice library
-
-Work in Progress ... the library should be available in a few weeks.
+An NTT-based Fast Lattice library
 
 ## Goal
 
 NFLlib is an efficient and open-source C++ library dedicated to ideal lattice cryptography. It is specialized in polynomial rings quotiented by a cyclotomic polynomial whose degree is a power of two. The library combines algorithmic optimizations (Chinese Remainder Theorem, optimized Number Theoretic Transform) together with programming optimization techniques (SSE and AVX2 specializations, C++ expression templates, etc.).
 
 ## License
 
-When published here the library will be available under an open source license.
+MIT
+
+# Install Steps
+
+You need cmake, GMP and Mpfr, as well as a C++11 compiler to build NFLLib.
+
+To build, test and install a production version of nfllib, run the following:
+
+```
+$> mkdir _build
+$> cd _build
+$> cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=$HOME/nfllib
+$> make
+$> make test
+$> make install
+```
+
+The following CMake options are relevant:
+
+Option                              | Description
+------------------------------------|---------------------------------
+`-DCMAKE_INSTALL_PREFIX=<value>`    | Where the library is installed
+`-DCMAKE_BUILD_TYPE=Release\|Debug` | The basic compiler configuration
+`-DNFL_OPTIMIZED=ON`                | Enable SSE/AVX-based optimization
+
+# SSE/AVX optimizations
+
+To use SSE-based optimizations, compile the code with the flags `-DNFL_OPTIMIZED=ON -DNTT_SSE`.
+
+To use AVX-based optimizations, compile the code with the flags `-DNFL_OPTIMIZED=ON -DNTT_AVX2`.
+
+# Getting started
+
+In order to get the documentation you need Sphinx and the Alabaster theme. Installation procedures are described at (we recommend using pip for both installations) :
+
+  * http://www.sphinx-doc.org/en/stable/install.html
+  * https://anaconda.org/pypi/alabaster
+
+After getting both Sphinx and the Alabaster theme build the documentation and show it with:
 
+```
+$> sphinx-build . build
+$> your_favorite_browser build/nfl.html
+```
 
-## Contributors 
+If you have issues building the documentation please contact the developper team.
 
-This library is an extension/evolution of the NTTTools module from [XPIR](https://github.com/XPIR-team/XPIR) done by members of [Cryptoexperts](https://www.cryptoexperts.com), [INP ENSEEIHT](http://www.enseeiht.com), [Quarkslab](http://www.quarkslab.com) (in alphabetical order).
+# Contributors
 
+This library is an extension/evolution of the NTTTools module from [XPIR](https://github.com/XPIR-team/XPIR) done by members of [CryptoExperts](https://www.cryptoexperts.com), [INP ENSEEIHT](http://www.enseeiht.com), [Quarkslab](http://www.quarkslab.com) (in alphabetical order).

cmake/FindCEREAL.cmake

@@ -0,0 +1,10 @@
+# Copyright (c) 2016 NFLlib
+
+set(CEREAL_PREFIX "" CACHE PATH "The path to the prefix of an CEREAL installation")
+
+find_path(CEREAL_INCLUDE_DIR cereal
+PATHS ${CEREAL_PREFIX}/include /usr/include /usr/local/include)
+
+if(CEREAL_INCLUDE_DIR)
+set(CEREAL_FOUND TRUE)
+endif()

cmake/FindGMP.cmake

@@ -0,0 +1,36 @@
+# Copyright (c) 2008-2010 Kent State University
+# Copyright (c) 2011-2012 Texas A&M University
+#
+# This file is distributed under the MIT License. See the accompanying file
+# LICENSE.txt or http://www.opensource.org/licenses/mit-license.php for terms
+# and conditions.
+
+# FIXME: How do I find the version of GMP that I want to use?
+# What versions are available?
+
+# NOTE: GMP prefix is understood to be the path to the root of the GMP
+# installation library.
+set(GMP_PREFIX "" CACHE PATH "The path to the prefix of a GMP installation")
+
+
+find_path(GMP_INCLUDE_DIR gmp.h
+PATHS ${GMP_PREFIX}/include /usr/include /usr/local/include)
+
+find_library(GMP_LIBRARY NAMES gmp
+PATHS ${GMP_PREFIX}/lib /usr/lib /usr/local/lib)
+
+
+if(GMP_INCLUDE_DIR AND GMP_LIBRARY)
+get_filename_component(GMP_LIBRARY_DIR ${GMP_LIBRARY} PATH)
+set(GMP_FOUND TRUE)
+endif()
+
+if(GMP_FOUND)
+if(NOT GMP_FIND_QUIETLY)
+MESSAGE(STATUS "Found GMP: ${GMP_LIBRARY}")
+endif()
+elseif(GMP_FOUND)
+if(GMP_FIND_REQUIRED)
+message(FATAL_ERROR "Could not find GMP")
+endif()
+endif()

cmake/FindMPFR.cmake

@@ -0,0 +1,35 @@
+# Copyright (c) 2008-2010 Kent State University
+# Copyright (c) 2011-2012 Texas A&M University
+#
+# This file is distributed under the MIT License. See the accompanying file
+# LICENSE.txt or http://www.opensource.org/licenses/mit-license.php for terms
+# and conditions.
+
+# FIXME: How do I find the version of MPFR that I want to use?
+# What versions are available?
+
+# NOTE: MPFR prefix is understood to be the path to the root of the MPFR
+# installation library.
+set(MPFR_PREFIX "" CACHE PATH "The path to the previx of an MPFR installation")
+
+find_path(MPFR_INCLUDE_DIR mpfr.h
+PATHS ${MPFR_PREFIX}/include /usr/include /usr/local/include)
+
+find_library(MPFR_LIBRARY NAMES mpfr
+PATHS ${MPFR_PREFIX}/lib /usr/lib /usr/local/lib)
+
+if(MPFR_INCLUDE_DIR AND MPFR_LIBRARY)
+get_filename_component(MPFR_LIBRARY_DIR ${MPFR_LIBRARY} PATH)
+set(MPFR_FOUND TRUE)
+endif()
+
+
+if(MPFR_FOUND)
+if(NOT MPFR_FIND_QUIETLY)
+MESSAGE(STATUS "Found MPFR: ${MPFR_LIBRARY}")
+endif()
+elseif(MPFR_FOUND)
+if(MPFR_FIND_REQUIRED)
+message(FATAL_ERROR "Could not find MPFR")
+endif()
+endif()