libigl/include/igl/adjacency_list.h

// This file is part of libigl, a simple c++ geometry processing library.
// 
// Copyright (C) 2013 Alec Jacobson <[email protected]>
// 
// This Source Code Form is subject to the terms of the Mozilla Public License 
// v. 2.0. If a copy of the MPL was not distributed with this file, You can 
// obtain one at http://mozilla.org/MPL/2.0/.
#ifndef IGL_ADJACENCY_LIST_H
#define IGL_ADJACENCY_LIST_H
#include "igl_inline.h"

#include <Eigen/Dense>
#include <Eigen/Sparse>
#include <vector>
namespace igl 
{
  /// Constructs the graph adjacency list of a given mesh (V,F)
  ///
  /// @tparam T  should be a eigen sparse matrix primitive type like int or double
  /// @param[in] F       #F by dim list of mesh faces (must be triangles)
  /// @param[out] A  vector<vector<T> > containing at row i the adjacent vertices of vertex i
  /// @param[in] sorted  flag that indicates if the list should be sorted counter-clockwise. Input assumed to be manifold.
  ///
  /// Example:
  /// \code{.cpp}
  ///   // Mesh in (V,F)
  ///   vector<vector<double> > A;
  ///   adjacency_list(F,A);
  /// \endcode
  ///
  /// \see 
  ///   adjacency_matrix
  ///   edges, 
  ///   cotmatrix, 
  ///   diag
  template <typename Index, typename IndexVector>
  IGL_INLINE void adjacency_list(
    const Eigen::MatrixBase<Index>  & F,
    std::vector<std::vector<IndexVector> >& A,
    bool sorted = false);
  /// Constructs the graph adjacency list of a given _polygon_ mesh (V,F)
  ///
  /// @tparam T  should be a eigen sparse matrix primitive type like int or double
  /// @param[in] F       #F list of polygon face index lists
  /// @param[out] A  vector<vector<T> > containing at row i the adjacent vertices of vertex i
  template <typename Index>
  IGL_INLINE void adjacency_list(
    const std::vector<std::vector<Index> > & F,
    std::vector<std::vector<Index> >& A);

}

#ifndef IGL_STATIC_LIBRARY
#  include "adjacency_list.cpp"
#endif

#endif