Blame cmake/FindSuiteSparse.cmake

Packit ea1746
# Ceres Solver - A fast non-linear least squares minimizer
Packit ea1746
# Copyright 2015 Google Inc. All rights reserved.
Packit ea1746
# http://ceres-solver.org/
Packit ea1746
#
Packit ea1746
# Redistribution and use in source and binary forms, with or without
Packit ea1746
# modification, are permitted provided that the following conditions are met:
Packit ea1746
#
Packit ea1746
# * Redistributions of source code must retain the above copyright notice,
Packit ea1746
#   this list of conditions and the following disclaimer.
Packit ea1746
# * Redistributions in binary form must reproduce the above copyright notice,
Packit ea1746
#   this list of conditions and the following disclaimer in the documentation
Packit ea1746
#   and/or other materials provided with the distribution.
Packit ea1746
# * Neither the name of Google Inc. nor the names of its contributors may be
Packit ea1746
#   used to endorse or promote products derived from this software without
Packit ea1746
#   specific prior written permission.
Packit ea1746
#
Packit ea1746
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Packit ea1746
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Packit ea1746
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Packit ea1746
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
Packit ea1746
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
Packit ea1746
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
Packit ea1746
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
Packit ea1746
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
Packit ea1746
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
Packit ea1746
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Packit ea1746
# POSSIBILITY OF SUCH DAMAGE.
Packit ea1746
#
Packit ea1746
# Author: alexs.mac@gmail.com (Alex Stewart)
Packit ea1746
#
Packit ea1746
Packit ea1746
# FindSuiteSparse.cmake - Find SuiteSparse libraries & dependencies.
Packit ea1746
#
Packit ea1746
# This module defines the following variables:
Packit ea1746
#
Packit ea1746
# SUITESPARSE_FOUND: TRUE iff SuiteSparse and all dependencies have been found.
Packit ea1746
# SUITESPARSE_INCLUDE_DIRS: Include directories for all SuiteSparse components.
Packit ea1746
# SUITESPARSE_LIBRARIES: Libraries for all SuiteSparse component libraries and
Packit ea1746
#                        dependencies.
Packit ea1746
# SUITESPARSE_VERSION: Extracted from UFconfig.h (<= v3) or
Packit ea1746
#                      SuiteSparse_config.h (>= v4).
Packit ea1746
# SUITESPARSE_MAIN_VERSION: Equal to 4 if SUITESPARSE_VERSION = 4.2.1
Packit ea1746
# SUITESPARSE_SUB_VERSION: Equal to 2 if SUITESPARSE_VERSION = 4.2.1
Packit ea1746
# SUITESPARSE_SUBSUB_VERSION: Equal to 1 if SUITESPARSE_VERSION = 4.2.1
Packit ea1746
#
Packit ea1746
# SUITESPARSE_IS_BROKEN_SHARED_LINKING_UBUNTU_SYSTEM_VERSION: TRUE iff running
Packit ea1746
#     on Ubuntu, SUITESPARSE_VERSION is 3.4.0 and found SuiteSparse is a system
Packit ea1746
#     install, in which case found version of SuiteSparse cannot be used to link
Packit ea1746
#     a shared library due to a bug (static linking is unaffected).
Packit ea1746
#
Packit ea1746
# The following variables control the behaviour of this module:
Packit ea1746
#
Packit ea1746
# SUITESPARSE_INCLUDE_DIR_HINTS: List of additional directories in which to
Packit ea1746
#                                search for SuiteSparse includes,
Packit ea1746
#                                e.g: /timbuktu/include.
Packit ea1746
# SUITESPARSE_LIBRARY_DIR_HINTS: List of additional directories in which to
Packit ea1746
#                                search for SuiteSparse libraries,
Packit ea1746
#                                e.g: /timbuktu/lib.
Packit ea1746
#
Packit ea1746
# The following variables define the presence / includes & libraries for the
Packit ea1746
# SuiteSparse components searched for, the SUITESPARSE_XX variables are the
Packit ea1746
# union of the variables for all components.
Packit ea1746
#
Packit ea1746
# == Symmetric Approximate Minimum Degree (AMD)
Packit ea1746
# AMD_FOUND
Packit ea1746
# AMD_INCLUDE_DIR
Packit ea1746
# AMD_LIBRARY
Packit ea1746
#
Packit ea1746
# == Constrained Approximate Minimum Degree (CAMD)
Packit ea1746
# CAMD_FOUND
Packit ea1746
# CAMD_INCLUDE_DIR
Packit ea1746
# CAMD_LIBRARY
Packit ea1746
#
Packit ea1746
# == Column Approximate Minimum Degree (COLAMD)
Packit ea1746
# COLAMD_FOUND
Packit ea1746
# COLAMD_INCLUDE_DIR
Packit ea1746
# COLAMD_LIBRARY
Packit ea1746
#
Packit ea1746
# Constrained Column Approximate Minimum Degree (CCOLAMD)
Packit ea1746
# CCOLAMD_FOUND
Packit ea1746
# CCOLAMD_INCLUDE_DIR
Packit ea1746
# CCOLAMD_LIBRARY
Packit ea1746
#
Packit ea1746
# == Sparse Supernodal Cholesky Factorization and Update/Downdate (CHOLMOD)
Packit ea1746
# CHOLMOD_FOUND
Packit ea1746
# CHOLMOD_INCLUDE_DIR
Packit ea1746
# CHOLMOD_LIBRARY
Packit ea1746
#
Packit ea1746
# == Multifrontal Sparse QR (SuiteSparseQR)
Packit ea1746
# SUITESPARSEQR_FOUND
Packit ea1746
# SUITESPARSEQR_INCLUDE_DIR
Packit ea1746
# SUITESPARSEQR_LIBRARY
Packit ea1746
#
Packit ea1746
# == Common configuration for all but CSparse (SuiteSparse version >= 4).
Packit ea1746
# SUITESPARSE_CONFIG_FOUND
Packit ea1746
# SUITESPARSE_CONFIG_INCLUDE_DIR
Packit ea1746
# SUITESPARSE_CONFIG_LIBRARY
Packit ea1746
#
Packit ea1746
# == Common configuration for all but CSparse (SuiteSparse version < 4).
Packit ea1746
# UFCONFIG_FOUND
Packit ea1746
# UFCONFIG_INCLUDE_DIR
Packit ea1746
#
Packit ea1746
# Optional SuiteSparse Dependencies:
Packit ea1746
#
Packit ea1746
# == Serial Graph Partitioning and Fill-reducing Matrix Ordering (METIS)
Packit ea1746
# METIS_FOUND
Packit ea1746
# METIS_LIBRARY
Packit ea1746
#
Packit ea1746
# == Intel Thread Building Blocks (TBB)
Packit ea1746
# TBB_FOUND
Packit ea1746
# TBB_LIBRARY
Packit ea1746
# TBB_MALLOC_FOUND
Packit ea1746
# TBB_MALLOC_LIBRARY
Packit ea1746
Packit ea1746
# Reset CALLERS_CMAKE_FIND_LIBRARY_PREFIXES to its value when
Packit ea1746
# FindSuiteSparse was invoked.
Packit ea1746
macro(SUITESPARSE_RESET_FIND_LIBRARY_PREFIX)
Packit ea1746
  if (MSVC)
Packit ea1746
    set(CMAKE_FIND_LIBRARY_PREFIXES "${CALLERS_CMAKE_FIND_LIBRARY_PREFIXES}")
Packit ea1746
  endif (MSVC)
Packit ea1746
endmacro(SUITESPARSE_RESET_FIND_LIBRARY_PREFIX)
Packit ea1746
Packit ea1746
# Called if we failed to find SuiteSparse or any of it's required dependencies,
Packit ea1746
# unsets all public (designed to be used externally) variables and reports
Packit ea1746
# error message at priority depending upon [REQUIRED/QUIET/<NONE>] argument.
Packit ea1746
macro(SUITESPARSE_REPORT_NOT_FOUND REASON_MSG)
Packit ea1746
  unset(SUITESPARSE_FOUND)
Packit ea1746
  unset(SUITESPARSE_INCLUDE_DIRS)
Packit ea1746
  unset(SUITESPARSE_LIBRARIES)
Packit ea1746
  unset(SUITESPARSE_VERSION)
Packit ea1746
  unset(SUITESPARSE_MAIN_VERSION)
Packit ea1746
  unset(SUITESPARSE_SUB_VERSION)
Packit ea1746
  unset(SUITESPARSE_SUBSUB_VERSION)
Packit ea1746
  # Do NOT unset SUITESPARSE_FOUND_REQUIRED_VARS here, as it is used by
Packit ea1746
  # FindPackageHandleStandardArgs() to generate the automatic error message on
Packit ea1746
  # failure which highlights which components are missing.
Packit ea1746
Packit ea1746
  suitesparse_reset_find_library_prefix()
Packit ea1746
Packit ea1746
  # Note <package>_FIND_[REQUIRED/QUIETLY] variables defined by FindPackage()
Packit ea1746
  # use the camelcase library name, not uppercase.
Packit ea1746
  if (SuiteSparse_FIND_QUIETLY)
Packit ea1746
    message(STATUS "Failed to find SuiteSparse - " ${REASON_MSG} ${ARGN})
Packit ea1746
  elseif (SuiteSparse_FIND_REQUIRED)
Packit ea1746
    message(FATAL_ERROR "Failed to find SuiteSparse - " ${REASON_MSG} ${ARGN})
Packit ea1746
  else()
Packit ea1746
    # Neither QUIETLY nor REQUIRED, use no priority which emits a message
Packit ea1746
    # but continues configuration and allows generation.
Packit ea1746
    message("-- Failed to find SuiteSparse - " ${REASON_MSG} ${ARGN})
Packit ea1746
  endif (SuiteSparse_FIND_QUIETLY)
Packit ea1746
Packit ea1746
  # Do not call return(), s/t we keep processing if not called with REQUIRED
Packit ea1746
  # and report all missing components, rather than bailing after failing to find
Packit ea1746
  # the first.
Packit ea1746
endmacro(SUITESPARSE_REPORT_NOT_FOUND)
Packit ea1746
Packit ea1746
# Protect against any alternative find_package scripts for this library having
Packit ea1746
# been called previously (in a client project) which set SUITESPARSE_FOUND, but
Packit ea1746
# not the other variables we require / set here which could cause the search
Packit ea1746
# logic here to fail.
Packit ea1746
unset(SUITESPARSE_FOUND)
Packit ea1746
Packit ea1746
# Handle possible presence of lib prefix for libraries on MSVC, see
Packit ea1746
# also SUITESPARSE_RESET_FIND_LIBRARY_PREFIX().
Packit ea1746
if (MSVC)
Packit ea1746
  # Preserve the caller's original values for CMAKE_FIND_LIBRARY_PREFIXES
Packit ea1746
  # s/t we can set it back before returning.
Packit ea1746
  set(CALLERS_CMAKE_FIND_LIBRARY_PREFIXES "${CMAKE_FIND_LIBRARY_PREFIXES}")
Packit ea1746
  # The empty string in this list is important, it represents the case when
Packit ea1746
  # the libraries have no prefix (shared libraries / DLLs).
Packit ea1746
  set(CMAKE_FIND_LIBRARY_PREFIXES "lib" "" "${CMAKE_FIND_LIBRARY_PREFIXES}")
Packit ea1746
endif (MSVC)
Packit ea1746
Packit ea1746
# Specify search directories for include files and libraries (this is the union
Packit ea1746
# of the search directories for all OSs).  Search user-specified hint
Packit ea1746
# directories first if supplied, and search user-installed locations first
Packit ea1746
# so that we prefer user installs to system installs where both exist.
Packit ea1746
list(APPEND SUITESPARSE_CHECK_INCLUDE_DIRS
Packit ea1746
  /opt/local/include
Packit ea1746
  /opt/local/include/ufsparse # Mac OS X
Packit ea1746
  /usr/local/homebrew/include # Mac OS X
Packit ea1746
  /usr/local/include
Packit ea1746
  /usr/include)
Packit ea1746
list(APPEND SUITESPARSE_CHECK_LIBRARY_DIRS
Packit ea1746
  /opt/local/lib
Packit ea1746
  /opt/local/lib/ufsparse # Mac OS X
Packit ea1746
  /usr/local/homebrew/lib # Mac OS X
Packit ea1746
  /usr/local/lib
Packit ea1746
  /usr/lib)
Packit ea1746
# Additional suffixes to try appending to each search path.
Packit ea1746
list(APPEND SUITESPARSE_CHECK_PATH_SUFFIXES
Packit ea1746
  suitesparse) # Windows/Ubuntu
Packit ea1746
Packit ea1746
# Wrappers to find_path/library that pass the SuiteSparse search hints/paths.
Packit ea1746
#
Packit ea1746
# suitesparse_find_component(<component> [FILES name1 [name2 ...]]
Packit ea1746
#                                        [LIBRARIES name1 [name2 ...]]
Packit ea1746
#                                        [REQUIRED])
Packit ea1746
macro(suitesparse_find_component COMPONENT)
Packit ea1746
  include(CMakeParseArguments)
Packit ea1746
  set(OPTIONS REQUIRED)
Packit ea1746
  set(MULTI_VALUE_ARGS FILES LIBRARIES)
Packit ea1746
  cmake_parse_arguments(SUITESPARSE_FIND_${COMPONENT}
Packit ea1746
    "${OPTIONS}" "" "${MULTI_VALUE_ARGS}" ${ARGN})
Packit ea1746
Packit ea1746
  if (SUITESPARSE_FIND_${COMPONENT}_REQUIRED)
Packit ea1746
    list(APPEND SUITESPARSE_FOUND_REQUIRED_VARS ${COMPONENT}_FOUND)
Packit ea1746
  endif()
Packit ea1746
Packit ea1746
  set(${COMPONENT}_FOUND TRUE)
Packit ea1746
  if (SUITESPARSE_FIND_${COMPONENT}_FILES)
Packit ea1746
    find_path(${COMPONENT}_INCLUDE_DIR
Packit ea1746
      NAMES ${SUITESPARSE_FIND_${COMPONENT}_FILES}
Packit ea1746
      HINTS ${SUITESPARSE_INCLUDE_DIR_HINTS}
Packit ea1746
      PATHS ${SUITESPARSE_CHECK_INCLUDE_DIRS}
Packit ea1746
      PATH_SUFFIXES ${SUITESPARSE_CHECK_PATH_SUFFIXES})
Packit ea1746
    if (${COMPONENT}_INCLUDE_DIR)
Packit ea1746
      message(STATUS "Found ${COMPONENT} headers in: "
Packit ea1746
        "${${COMPONENT}_INCLUDE_DIR}")
Packit ea1746
      mark_as_advanced(${COMPONENT}_INCLUDE_DIR)
Packit ea1746
    else()
Packit ea1746
      # Specified headers not found.
Packit ea1746
      set(${COMPONENT}_FOUND FALSE)
Packit ea1746
      if (SUITESPARSE_FIND_${COMPONENT}_REQUIRED)
Packit ea1746
        suitesparse_report_not_found(
Packit ea1746
          "Did not find ${COMPONENT} header (required SuiteSparse component).")
Packit ea1746
      else()
Packit ea1746
        message(STATUS "Did not find ${COMPONENT} header (optional "
Packit ea1746
          "SuiteSparse component).")
Packit ea1746
      endif()
Packit ea1746
    endif()
Packit ea1746
  endif()
Packit ea1746
Packit ea1746
  if (SUITESPARSE_FIND_${COMPONENT}_LIBRARIES)
Packit ea1746
    find_library(${COMPONENT}_LIBRARY
Packit ea1746
      NAMES ${SUITESPARSE_FIND_${COMPONENT}_LIBRARIES}
Packit ea1746
      HINTS ${SUITESPARSE_LIBRARY_DIR_HINTS}
Packit ea1746
      PATHS ${SUITESPARSE_CHECK_LIBRARY_DIRS}
Packit ea1746
      PATH_SUFFIXES ${SUITESPARSE_CHECK_PATH_SUFFIXES})
Packit ea1746
    if (${COMPONENT}_LIBRARY)
Packit ea1746
      message(STATUS "Found ${COMPONENT} library: ${${COMPONENT}_LIBRARY}")
Packit ea1746
      mark_as_advanced(${COMPONENT}_LIBRARY)
Packit ea1746
    else ()
Packit ea1746
      # Specified libraries not found.
Packit ea1746
      set(${COMPONENT}_FOUND FALSE)
Packit ea1746
      if (SUITESPARSE_FIND_${COMPONENT}_REQUIRED)
Packit ea1746
        suitesparse_report_not_found(
Packit ea1746
          "Did not find ${COMPONENT} library (required SuiteSparse component).")
Packit ea1746
      else()
Packit ea1746
        message(STATUS "Did not find ${COMPONENT} library (optional SuiteSparse "
Packit ea1746
          "dependency)")
Packit ea1746
      endif()
Packit ea1746
    endif()
Packit ea1746
  endif()
Packit ea1746
endmacro()
Packit ea1746
Packit ea1746
# Given the number of components of SuiteSparse, and to ensure that the
Packit ea1746
# automatic failure message generated by FindPackageHandleStandardArgs()
Packit ea1746
# when not all required components are found is helpful, we maintain a list
Packit ea1746
# of all variables that must be defined for SuiteSparse to be considered found.
Packit ea1746
unset(SUITESPARSE_FOUND_REQUIRED_VARS)
Packit ea1746
Packit ea1746
# BLAS.
Packit ea1746
find_package(BLAS QUIET)
Packit ea1746
if (NOT BLAS_FOUND)
Packit ea1746
  suitesparse_report_not_found(
Packit ea1746
    "Did not find BLAS library (required for SuiteSparse).")
Packit ea1746
endif (NOT BLAS_FOUND)
Packit ea1746
list(APPEND SUITESPARSE_FOUND_REQUIRED_VARS BLAS_FOUND)
Packit ea1746
Packit ea1746
# LAPACK.
Packit ea1746
find_package(LAPACK QUIET)
Packit ea1746
if (NOT LAPACK_FOUND)
Packit ea1746
  suitesparse_report_not_found(
Packit ea1746
    "Did not find LAPACK library (required for SuiteSparse).")
Packit ea1746
endif (NOT LAPACK_FOUND)
Packit ea1746
list(APPEND SUITESPARSE_FOUND_REQUIRED_VARS LAPACK_FOUND)
Packit ea1746
Packit ea1746
suitesparse_find_component(AMD REQUIRED FILES amd.h LIBRARIES amd)
Packit ea1746
suitesparse_find_component(CAMD REQUIRED FILES camd.h LIBRARIES camd)
Packit ea1746
suitesparse_find_component(COLAMD REQUIRED FILES colamd.h LIBRARIES colamd)
Packit ea1746
suitesparse_find_component(CCOLAMD REQUIRED FILES ccolamd.h LIBRARIES ccolamd)
Packit ea1746
suitesparse_find_component(CHOLMOD REQUIRED FILES cholmod.h LIBRARIES cholmod)
Packit ea1746
suitesparse_find_component(
Packit ea1746
  SUITESPARSEQR REQUIRED FILES SuiteSparseQR.hpp LIBRARIES spqr)
Packit ea1746
if (SUITESPARSEQR_FOUND)
Packit ea1746
  # SuiteSparseQR may be compiled with Intel Threading Building Blocks,
Packit ea1746
  # we assume that if TBB is installed, SuiteSparseQR was compiled with
Packit ea1746
  # support for it, this will do no harm if it wasn't.
Packit ea1746
  suitesparse_find_component(TBB LIBRARIES tbb)
Packit ea1746
  if (TBB_FOUND)
Packit ea1746
    message(STATUS "Found Intel Thread Building Blocks (TBB) library: "
Packit ea1746
      "${TBB_LIBRARY}, assuming SuiteSparseQR was compiled with TBB.")
Packit ea1746
    suitesparse_find_component(TBB_MALLOC LIBRARIES tbbmalloc)
Packit ea1746
    if (TBB_MALLOC_FOUND)
Packit ea1746
      message(STATUS "Found Intel Thread Building Blocks (TBB) Malloc library: "
Packit ea1746
        "${TBB_MALLOC_LIBRARY}")
Packit ea1746
      # Add the TBB libraries to the SuiteSparseQR libraries (the only
Packit ea1746
      # libraries to optionally depend on TBB).
Packit ea1746
      list(APPEND SUITESPARSEQR_LIBRARY ${TBB_LIBRARY} ${TBB_MALLOC_LIBRARY})
Packit ea1746
    else()
Packit ea1746
      message(STATUS "Did not find Intel Thread Building Blocks (TBB) Malloc "
Packit ea1746
        "Library, discarding TBB as a dependency.")
Packit ea1746
    endif()
Packit ea1746
  else()
Packit ea1746
    message(STATUS "Did not find Intel TBB library, assuming SuiteSparseQR was "
Packit ea1746
      "not compiled with TBB.")
Packit ea1746
  endif()
Packit ea1746
endif(SUITESPARSEQR_FOUND)
Packit ea1746
Packit ea1746
# UFconfig / SuiteSparse_config.
Packit ea1746
#
Packit ea1746
# If SuiteSparse version is >= 4 then SuiteSparse_config is required.
Packit ea1746
# For SuiteSparse 3, UFconfig.h is required.
Packit ea1746
suitesparse_find_component(
Packit ea1746
  SUITESPARSE_CONFIG FILES SuiteSparse_config.h LIBRARIES suitesparseconfig)
Packit ea1746
Packit ea1746
if (SUITESPARSE_CONFIG_FOUND)
Packit ea1746
  # SuiteSparse_config (SuiteSparse version >= 4) requires librt library for
Packit ea1746
  # timing by default when compiled on Linux or Unix, but not on OSX (which
Packit ea1746
  # does not have librt).
Packit ea1746
  if (CMAKE_SYSTEM_NAME MATCHES "Linux" OR UNIX AND NOT APPLE)
Packit ea1746
    suitesparse_find_component(LIBRT LIBRARIES rt)
Packit ea1746
    if (LIBRT_FOUND)
Packit ea1746
      message(STATUS "Adding librt: ${LIBRT_LIBRARY} to "
Packit ea1746
        "SuiteSparse_config libraries (required on Linux & Unix [not OSX] if "
Packit ea1746
        "SuiteSparse is compiled with timing).")
Packit ea1746
      list(APPEND SUITESPARSE_CONFIG_LIBRARY ${LIBRT_LIBRARY})
Packit ea1746
    else()
Packit ea1746
      message(STATUS "Could not find librt, but found SuiteSparse_config, "
Packit ea1746
        "assuming that SuiteSparse was compiled without timing.")
Packit ea1746
    endif ()
Packit ea1746
  endif (CMAKE_SYSTEM_NAME MATCHES "Linux" OR UNIX AND NOT APPLE)
Packit ea1746
else()
Packit ea1746
  # Failed to find SuiteSparse_config (>= v4 installs), instead look for
Packit ea1746
  # UFconfig header which should be present in < v4 installs.
Packit ea1746
  suitesparse_find_component(UFCONFIG FILES UFconfig.h)
Packit ea1746
endif ()
Packit ea1746
Packit ea1746
if (NOT SUITESPARSE_CONFIG_FOUND AND
Packit ea1746
    NOT UFCONFIG_FOUND)
Packit ea1746
  suitesparse_report_not_found(
Packit ea1746
    "Failed to find either: SuiteSparse_config header & library (should be "
Packit ea1746
    "present in all SuiteSparse >= v4 installs), or UFconfig header (should "
Packit ea1746
    "be present in all SuiteSparse < v4 installs).")
Packit ea1746
endif()
Packit ea1746
Packit ea1746
# Extract the SuiteSparse version from the appropriate header (UFconfig.h for
Packit ea1746
# <= v3, SuiteSparse_config.h for >= v4).
Packit ea1746
list(APPEND SUITESPARSE_FOUND_REQUIRED_VARS SUITESPARSE_VERSION)
Packit ea1746
Packit ea1746
if (UFCONFIG_FOUND)
Packit ea1746
  # SuiteSparse version <= 3.
Packit ea1746
  set(SUITESPARSE_VERSION_FILE ${UFCONFIG_INCLUDE_DIR}/UFconfig.h)
Packit ea1746
  if (NOT EXISTS ${SUITESPARSE_VERSION_FILE})
Packit ea1746
    suitesparse_report_not_found(
Packit ea1746
      "Could not find file: ${SUITESPARSE_VERSION_FILE} containing version "
Packit ea1746
      "information for <= v3 SuiteSparse installs, but UFconfig was found "
Packit ea1746
      "(only present in <= v3 installs).")
Packit ea1746
  else (NOT EXISTS ${SUITESPARSE_VERSION_FILE})
Packit ea1746
    file(READ ${SUITESPARSE_VERSION_FILE} UFCONFIG_CONTENTS)
Packit ea1746
Packit ea1746
    string(REGEX MATCH "#define SUITESPARSE_MAIN_VERSION [0-9]+"
Packit ea1746
      SUITESPARSE_MAIN_VERSION "${UFCONFIG_CONTENTS}")
Packit ea1746
    string(REGEX REPLACE "#define SUITESPARSE_MAIN_VERSION ([0-9]+)" "\\1"
Packit ea1746
      SUITESPARSE_MAIN_VERSION "${SUITESPARSE_MAIN_VERSION}")
Packit ea1746
Packit ea1746
    string(REGEX MATCH "#define SUITESPARSE_SUB_VERSION [0-9]+"
Packit ea1746
      SUITESPARSE_SUB_VERSION "${UFCONFIG_CONTENTS}")
Packit ea1746
    string(REGEX REPLACE "#define SUITESPARSE_SUB_VERSION ([0-9]+)" "\\1"
Packit ea1746
      SUITESPARSE_SUB_VERSION "${SUITESPARSE_SUB_VERSION}")
Packit ea1746
Packit ea1746
    string(REGEX MATCH "#define SUITESPARSE_SUBSUB_VERSION [0-9]+"
Packit ea1746
      SUITESPARSE_SUBSUB_VERSION "${UFCONFIG_CONTENTS}")
Packit ea1746
    string(REGEX REPLACE "#define SUITESPARSE_SUBSUB_VERSION ([0-9]+)" "\\1"
Packit ea1746
      SUITESPARSE_SUBSUB_VERSION "${SUITESPARSE_SUBSUB_VERSION}")
Packit ea1746
Packit ea1746
    # This is on a single line s/t CMake does not interpret it as a list of
Packit ea1746
    # elements and insert ';' separators which would result in 4.;2.;1 nonsense.
Packit ea1746
    set(SUITESPARSE_VERSION
Packit ea1746
      "${SUITESPARSE_MAIN_VERSION}.${SUITESPARSE_SUB_VERSION}.${SUITESPARSE_SUBSUB_VERSION}")
Packit ea1746
  endif (NOT EXISTS ${SUITESPARSE_VERSION_FILE})
Packit ea1746
endif (UFCONFIG_FOUND)
Packit ea1746
Packit ea1746
if (SUITESPARSE_CONFIG_FOUND)
Packit ea1746
  # SuiteSparse version >= 4.
Packit ea1746
  set(SUITESPARSE_VERSION_FILE
Packit ea1746
    ${SUITESPARSE_CONFIG_INCLUDE_DIR}/SuiteSparse_config.h)
Packit ea1746
  if (NOT EXISTS ${SUITESPARSE_VERSION_FILE})
Packit ea1746
    suitesparse_report_not_found(
Packit ea1746
      "Could not find file: ${SUITESPARSE_VERSION_FILE} containing version "
Packit ea1746
      "information for >= v4 SuiteSparse installs, but SuiteSparse_config was "
Packit ea1746
      "found (only present in >= v4 installs).")
Packit ea1746
  else (NOT EXISTS ${SUITESPARSE_VERSION_FILE})
Packit ea1746
    file(READ ${SUITESPARSE_VERSION_FILE} SUITESPARSE_CONFIG_CONTENTS)
Packit ea1746
Packit ea1746
    string(REGEX MATCH "#define SUITESPARSE_MAIN_VERSION [0-9]+"
Packit ea1746
      SUITESPARSE_MAIN_VERSION "${SUITESPARSE_CONFIG_CONTENTS}")
Packit ea1746
    string(REGEX REPLACE "#define SUITESPARSE_MAIN_VERSION ([0-9]+)" "\\1"
Packit ea1746
      SUITESPARSE_MAIN_VERSION "${SUITESPARSE_MAIN_VERSION}")
Packit ea1746
Packit ea1746
    string(REGEX MATCH "#define SUITESPARSE_SUB_VERSION [0-9]+"
Packit ea1746
      SUITESPARSE_SUB_VERSION "${SUITESPARSE_CONFIG_CONTENTS}")
Packit ea1746
    string(REGEX REPLACE "#define SUITESPARSE_SUB_VERSION ([0-9]+)" "\\1"
Packit ea1746
      SUITESPARSE_SUB_VERSION "${SUITESPARSE_SUB_VERSION}")
Packit ea1746
Packit ea1746
    string(REGEX MATCH "#define SUITESPARSE_SUBSUB_VERSION [0-9]+"
Packit ea1746
      SUITESPARSE_SUBSUB_VERSION "${SUITESPARSE_CONFIG_CONTENTS}")
Packit ea1746
    string(REGEX REPLACE "#define SUITESPARSE_SUBSUB_VERSION ([0-9]+)" "\\1"
Packit ea1746
      SUITESPARSE_SUBSUB_VERSION "${SUITESPARSE_SUBSUB_VERSION}")
Packit ea1746
Packit ea1746
    # This is on a single line s/t CMake does not interpret it as a list of
Packit ea1746
    # elements and insert ';' separators which would result in 4.;2.;1 nonsense.
Packit ea1746
    set(SUITESPARSE_VERSION
Packit ea1746
      "${SUITESPARSE_MAIN_VERSION}.${SUITESPARSE_SUB_VERSION}.${SUITESPARSE_SUBSUB_VERSION}")
Packit ea1746
  endif (NOT EXISTS ${SUITESPARSE_VERSION_FILE})
Packit ea1746
endif (SUITESPARSE_CONFIG_FOUND)
Packit ea1746
Packit ea1746
# METIS (Optional dependency).
Packit ea1746
suitesparse_find_component(METIS LIBRARIES metis)
Packit ea1746
Packit ea1746
# Only mark SuiteSparse as found if all required components and dependencies
Packit ea1746
# have been found.
Packit ea1746
set(SUITESPARSE_FOUND TRUE)
Packit ea1746
foreach(REQUIRED_VAR ${SUITESPARSE_FOUND_REQUIRED_VARS})
Packit ea1746
  if (NOT ${REQUIRED_VAR})
Packit ea1746
    set(SUITESPARSE_FOUND FALSE)
Packit ea1746
  endif (NOT ${REQUIRED_VAR})
Packit ea1746
endforeach(REQUIRED_VAR ${SUITESPARSE_FOUND_REQUIRED_VARS})
Packit ea1746
Packit ea1746
if (SUITESPARSE_FOUND)
Packit ea1746
  list(APPEND SUITESPARSE_INCLUDE_DIRS
Packit ea1746
    ${AMD_INCLUDE_DIR}
Packit ea1746
    ${CAMD_INCLUDE_DIR}
Packit ea1746
    ${COLAMD_INCLUDE_DIR}
Packit ea1746
    ${CCOLAMD_INCLUDE_DIR}
Packit ea1746
    ${CHOLMOD_INCLUDE_DIR}
Packit ea1746
    ${SUITESPARSEQR_INCLUDE_DIR})
Packit ea1746
  # Handle config separately, as otherwise at least one of them will be set
Packit ea1746
  # to NOTFOUND which would cause any check on SUITESPARSE_INCLUDE_DIRS to fail.
Packit ea1746
  if (SUITESPARSE_CONFIG_FOUND)
Packit ea1746
    list(APPEND SUITESPARSE_INCLUDE_DIRS
Packit ea1746
      ${SUITESPARSE_CONFIG_INCLUDE_DIR})
Packit ea1746
  endif (SUITESPARSE_CONFIG_FOUND)
Packit ea1746
  if (UFCONFIG_FOUND)
Packit ea1746
    list(APPEND SUITESPARSE_INCLUDE_DIRS
Packit ea1746
      ${UFCONFIG_INCLUDE_DIR})
Packit ea1746
  endif (UFCONFIG_FOUND)
Packit ea1746
  # As SuiteSparse includes are often all in the same directory, remove any
Packit ea1746
  # repetitions.
Packit ea1746
  list(REMOVE_DUPLICATES SUITESPARSE_INCLUDE_DIRS)
Packit ea1746
Packit ea1746
  # Important: The ordering of these libraries is *NOT* arbitrary, as these
Packit ea1746
  # could potentially be static libraries their link ordering is important.
Packit ea1746
  list(APPEND SUITESPARSE_LIBRARIES
Packit ea1746
    ${SUITESPARSEQR_LIBRARY}
Packit ea1746
    ${CHOLMOD_LIBRARY}
Packit ea1746
    ${CCOLAMD_LIBRARY}
Packit ea1746
    ${CAMD_LIBRARY}
Packit ea1746
    ${COLAMD_LIBRARY}
Packit ea1746
    ${AMD_LIBRARY}
Packit ea1746
    ${LAPACK_LIBRARIES}
Packit ea1746
    ${BLAS_LIBRARIES})
Packit ea1746
  if (SUITESPARSE_CONFIG_FOUND)
Packit ea1746
    list(APPEND SUITESPARSE_LIBRARIES
Packit ea1746
      ${SUITESPARSE_CONFIG_LIBRARY})
Packit ea1746
  endif (SUITESPARSE_CONFIG_FOUND)
Packit ea1746
  if (METIS_FOUND)
Packit ea1746
    list(APPEND SUITESPARSE_LIBRARIES
Packit ea1746
      ${METIS_LIBRARY})
Packit ea1746
  endif (METIS_FOUND)
Packit ea1746
endif()
Packit ea1746
Packit ea1746
# Determine if we are running on Ubuntu with the package install of SuiteSparse
Packit ea1746
# which is broken and does not support linking a shared library.
Packit ea1746
set(SUITESPARSE_IS_BROKEN_SHARED_LINKING_UBUNTU_SYSTEM_VERSION FALSE)
Packit ea1746
if (CMAKE_SYSTEM_NAME MATCHES "Linux" AND
Packit ea1746
    SUITESPARSE_VERSION VERSION_EQUAL 3.4.0)
Packit ea1746
  find_program(LSB_RELEASE_EXECUTABLE lsb_release)
Packit ea1746
  if (LSB_RELEASE_EXECUTABLE)
Packit ea1746
    # Any even moderately recent Ubuntu release (likely to be affected by
Packit ea1746
    # this bug) should have lsb_release, if it isn't present we are likely
Packit ea1746
    # on a different Linux distribution (should be fine).
Packit ea1746
    execute_process(COMMAND ${LSB_RELEASE_EXECUTABLE} -si
Packit ea1746
      OUTPUT_VARIABLE LSB_DISTRIBUTOR_ID
Packit ea1746
      OUTPUT_STRIP_TRAILING_WHITESPACE)
Packit ea1746
Packit ea1746
    if (LSB_DISTRIBUTOR_ID MATCHES "Ubuntu" AND
Packit ea1746
        SUITESPARSE_LIBRARIES MATCHES "/usr/lib/libamd")
Packit ea1746
      # We are on Ubuntu, and the SuiteSparse version matches the broken
Packit ea1746
      # system install version and is a system install.
Packit ea1746
      set(SUITESPARSE_IS_BROKEN_SHARED_LINKING_UBUNTU_SYSTEM_VERSION TRUE)
Packit ea1746
      message(STATUS "Found system install of SuiteSparse "
Packit ea1746
        "${SUITESPARSE_VERSION} running on Ubuntu, which has a known bug "
Packit ea1746
        "preventing linking of shared libraries (static linking unaffected).")
Packit ea1746
    endif (LSB_DISTRIBUTOR_ID MATCHES "Ubuntu" AND
Packit ea1746
      SUITESPARSE_LIBRARIES MATCHES "/usr/lib/libamd")
Packit ea1746
  endif (LSB_RELEASE_EXECUTABLE)
Packit ea1746
endif (CMAKE_SYSTEM_NAME MATCHES "Linux" AND
Packit ea1746
  SUITESPARSE_VERSION VERSION_EQUAL 3.4.0)
Packit ea1746
Packit ea1746
suitesparse_reset_find_library_prefix()
Packit ea1746
Packit ea1746
# Handle REQUIRED and QUIET arguments to FIND_PACKAGE
Packit ea1746
include(FindPackageHandleStandardArgs)
Packit ea1746
if (SUITESPARSE_FOUND)
Packit ea1746
  find_package_handle_standard_args(SuiteSparse
Packit ea1746
    REQUIRED_VARS ${SUITESPARSE_FOUND_REQUIRED_VARS}
Packit ea1746
    VERSION_VAR SUITESPARSE_VERSION
Packit ea1746
    FAIL_MESSAGE "Failed to find some/all required components of SuiteSparse.")
Packit ea1746
else (SUITESPARSE_FOUND)
Packit ea1746
  # Do not pass VERSION_VAR to FindPackageHandleStandardArgs() if we failed to
Packit ea1746
  # find SuiteSparse to avoid a confusing autogenerated failure message
Packit ea1746
  # that states 'not found (missing: FOO) (found version: x.y.z)'.
Packit ea1746
  find_package_handle_standard_args(SuiteSparse
Packit ea1746
    REQUIRED_VARS ${SUITESPARSE_FOUND_REQUIRED_VARS}
Packit ea1746
    FAIL_MESSAGE "Failed to find some/all required components of SuiteSparse.")
Packit ea1746
endif (SUITESPARSE_FOUND)