Skip to content

Latest commit

 

History

History
129 lines (97 loc) · 3.21 KB

integration.md

File metadata and controls

129 lines (97 loc) · 3.21 KB
Raw

Integration

This file describes how to integrate the library into your project.

Index

Requirements

Library requires:

  • C++ Standard Library
    • <cstdint>
    • <cstddef>
    • <cstring>
    • <bit>
    • <array>
    • <span>
    • <type_traits>
    • <vector>
  • C++ 20 Compiler

Supported compilers are:

  • gcc
  • clang
  • msvc

Optional:

  • nasm >= 2.16
    • Minimum version matters, due to use of builtins.
    • Version check is not performed because CMAKE_ASM_NASM_COMPILER_VERSION is not defined.
    • Must be available within in path, to be detected by CMake.
    • Just in path, no additional configuration is necessary :).
    • If available and the library is configured to use an assembly (default yes), additional performance-optimized backends will be available and dispatched based on CPU capabilities.
    • If not available, the library runs in generic mode using only software backends.
    • Currently only used when targeting x86-64.

Configuration

Library configuration table. To override the defaults, provide -D prefixed parameter to cmake during configuration step.

Parameter Type Default Description
MILO_APP option OFF Enable building milo application.
MILO_ASM option ON Enable assembly.
MILO_TEST option OFF Enable testing.
MILO_TEST_CONSTEXPR option OFF Enable constexpr testing.
MILO_TEST_INTERNAL option OFF Enable internal testing.
MILO_TEST_PRIMITIVE option OFF Enable primitive testing.

FetchContent

Link the library to the target directly with CMakeLists.txt:

include(FetchContent)

FetchContent_Declare(
        milo
        GIT_REPOSITORY https://github.com/milosob/milo.git
        GIT_TAG master
)

FetchContent_MakeAvailable(
        milo
)

target_link_libraries(
        target
        PRIVATE
        milo
)

Installation

Follow the instructions to install the project:

git clone --branch master https://github.com/milosob/milo.git milo
mkdir milo-build
cd milo-build
cmake ../milo -DMILO_TEST=ON -DMILO_TEST_CONSTEXPR=ON -DMILO_TEST_PRIMITIVE=ON -DMILO_APP=ON && make && ctest

If msvc is used do not configure library with -DMILO_TEST_CONSTEXPR=ON to perform constexpr tests. The library contains deep tests which combined with build parallelism can lead to yea, picture says it all.

milo-test-constexpr-msvc

This problem does not occur when other compilers are used.

# Using sudo may be required if installing to /usr/local.
cmake --install .

Link the installed library to the target in CMake:

find_package(
        milo
        CONFIG REQUIRED
)

target_link_libraries(
        target
        PRIVATE
        milo
)