cvrMedianEvenCase.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998 - 2005
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the authors 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.
 */



/**
 * \file   cvrMedianEvenCase.h
 *         Contains the enum eMedianCase which is used in
 *         cvr::quickMedian and related classes. Read/write functions
 *         are available.
 * \author Peter Doerfler
 * \date   23.03.2005
 *
 * $Id: cvrMedianEvenCase.h,v 1.1 2005/03/29 13:26:46 doerfler Exp $
 */

#ifndef _CVR_MEDIAN_EVEN_CASE_H
#define _CVR_MEDIAN_EVEN_CASE_H

#include "cvrIoHandler.h"

namespace cvr {

  /**
   * The median value of even length vectors is undefined. It can
   * either be the value before or after half the length. This enum is
   * used to specify which behaviour is desired: TakeLower or
   * TakeHigher.
   */
  enum eMedianEvenCase {
    TakeLower, /**< take the element with the lower index, i.e. N/2-1 with
                *   N the number of elements in the vector
                */
    TakeHigher /**< take the element with the higher index, i.e. N/2 with
                *   N the number of elements in the vector
                */
  };

  /**
   * read function for eMedianEvenCase.
   *
   * @ingroup gStorable
   */
  bool read(ioHandler& handler,eMedianEvenCase& data);

  /**
   * write function for eMedianEvenCase.
   *
   * @ingroup gStorable
   */
  bool write(ioHandler& handler,const eMedianEvenCase& data);

}

#endif