norms.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2010, Willow Garage, Inc.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of Willow Garage, Inc. nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef PCL_NORMS_H_
#define PCL_NORMS_H_

namespace pcl
{
  enum NormType {L1, L2_SQR, L2, LINF, JM, B, SUBLINEAR, CS, DIV, PF, K, KL, HIK};

  template <typename FloatVectorT> inline float
  selectNorm (FloatVectorT A, FloatVectorT B, int dim, NormType norm_type);

  template <typename FloatVectorT> inline float
  L1_Norm (FloatVectorT A, FloatVectorT B, int dim);
  
  template <typename FloatVectorT> inline float
  L2_Norm_SQR (FloatVectorT A, FloatVectorT B, int dim);
  
  template <typename FloatVectorT> inline float
  L2_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  Linf_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  JM_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  B_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  Sublinear_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  CS_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  Div_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  PF_Norm (FloatVectorT A, FloatVectorT B, int dim, float P1, float P2);

  template <typename FloatVectorT> inline float
  K_Norm (FloatVectorT A, FloatVectorT B, int dim, float P1, float P2);

  template <typename FloatVectorT> inline float
  KL_Norm (FloatVectorT A, FloatVectorT B, int dim);

  template <typename FloatVectorT> inline float
  HIK_Norm (FloatVectorT A, FloatVectorT B, int dim);
}
#include <pcl/common/impl/norms.hpp>

#endif  //#ifndef PCL_NORMS_H_