RealVectorBounds.h
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2010, Rice University
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Rice University nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 /* Author: Ioan Sucan */
36 
37 #ifndef OMPL_BASE_SPACES_REAL_VECTOR_BOUNDS_
38 #define OMPL_BASE_SPACES_REAL_VECTOR_BOUNDS_
39 
40 #include <vector>
41 
42 namespace ompl
43 {
44  namespace base
45  {
48  {
49  public:
51  RealVectorBounds(unsigned int dim)
52  {
53  resize(dim);
54  }
55 
57  void setLow(double value);
58 
60  void setHigh(double value);
61 
63  void setLow(unsigned int index, double value);
64 
66  void setHigh(unsigned int index, double value);
67 
69  void resize(std::size_t size);
70 
72  double getVolume() const;
73 
76  std::vector<double> getDifference() const;
77 
81  void check() const;
82 
84  std::vector<double> low;
85 
87  std::vector<double> high;
88  };
89  }
90 }
91 #endif
void resize(std::size_t size)
Change the number of dimensions for the bounds.
RealVectorBounds(unsigned int dim)
Constructor; dim represents the dimension of the space these bounds are for.
std::vector< double > low
Lower bound.
void setLow(double value)
Set the lower bound in each dimension to a specific value.
Main namespace. Contains everything in this library.
Definition: AppBase.h:21
void setHigh(double value)
Set the upper bound in each dimension to a specific value.
std::vector< double > getDifference() const
Get the difference between the high and low bounds for each dimension: result[i] = high[i] - low[i]...
std::vector< double > high
Upper bound.
void check() const
Check if the bounds are valid (same length for low and high, high[i] > low[i]). Throw an exception if...
The lower and upper bounds for an Rn space.
double getVolume() const
Compute the volume of the space enclosed by the bounds.