TimeStateSpace.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_TIME_STATE_SPACE_
38 #define OMPL_BASE_SPACES_TIME_STATE_SPACE_
39 
40 #include "ompl/base/StateSpace.h"
41 
42 namespace ompl
43 {
44  namespace base
45  {
48  {
49  public:
51  TimeStateSampler(const StateSpace *space) : StateSampler(space)
52  {
53  }
54 
55  void sampleUniform(State *state) override;
56  void sampleUniformNear(State *state, const State *near, double distance) override;
57  void sampleGaussian(State *state, const State *mean, double stdDev) override;
58  };
59 
69  class TimeStateSpace : public StateSpace
70  {
71  public:
73  class StateType : public State
74  {
75  public:
77  double position;
78  };
79 
81  {
82  setName("Time" + getName());
84  }
85 
86  ~TimeStateSpace() override = default;
87 
88  unsigned int getDimension() const override;
89 
90  double getMaximumExtent() const override;
91 
92  double getMeasure() const override;
93 
100  void setBounds(double minTime, double maxTime);
101 
104  double getMinTimeBound() const
105  {
106  return minTime_;
107  }
108 
111  double getMaxTimeBound() const
112  {
113  return maxTime_;
114  }
115 
117  bool isBounded() const
118  {
119  return bounded_;
120  }
121 
122  void enforceBounds(State *state) const override;
123 
124  bool satisfiesBounds(const State *state) const override;
125 
126  void copyState(State *destination, const State *source) const override;
127 
128  unsigned int getSerializationLength() const override;
129 
130  void serialize(void *serialization, const State *state) const override;
131 
132  void deserialize(State *state, const void *serialization) const override;
133 
134  double distance(const State *state1, const State *state2) const override;
135 
136  bool equalStates(const State *state1, const State *state2) const override;
137 
138  void interpolate(const State *from, const State *to, double t, State *state) const override;
139 
140  StateSamplerPtr allocDefaultStateSampler() const override;
141 
142  State *allocState() const override;
143 
144  void freeState(State *state) const override;
145 
146  double *getValueAddressAtIndex(State *state, unsigned int index) const override;
147 
148  void printState(const State *state, std::ostream &out) const override;
149 
150  void printSettings(std::ostream &out) const override;
151 
152  void registerProjections() override;
153 
154  protected:
156  bool bounded_{false};
157 
159  double minTime_{0.0};
160 
162  double maxTime_{0.0};
163  };
164  }
165 }
166 
167 #endif
void deserialize(State *state, const void *serialization) const override
Read the binary representation of a state from serialization and write it to state.
StateSamplerPtr allocDefaultStateSampler() const override
Allocate an instance of the default uniform state sampler for this space.
unsigned int getDimension() const override
Get the dimension of the space (not the dimension of the surrounding ambient space)
double maxTime_
The maximum point in time considered by the state space (if bounds are used)
Representation of a space in which planning can be performed. Topology specific sampling,...
Definition: StateSpace.h:71
double getMinTimeBound() const
Get the minimum allowed value of position in a state. The function returns 0 if time is not bounded.
double position
The position in time.
void freeState(State *state) const override
Free the memory of the allocated state.
void setBounds(double minTime, double maxTime)
Set the minimum and maximum time bounds. This will make the state space switch into bounded time mode...
A state space representing time. The time can be unbounded, in which case enforceBounds() is a no-op,...
Definition of an abstract state.
Definition: State.h:50
unsigned int getSerializationLength() const override
Get the number of chars in the serialization of a state in this space.
void copyState(State *destination, const State *source) const override
Copy a state to another. The memory of source and destination should NOT overlap.
void serialize(void *serialization, const State *state) const override
Write the binary representation of state to serialization.
State space sampler for time.
bool bounded_
Flag indicating whether the state space is considering bounds or not.
double getMaximumExtent() const override
Get the maximum value a call to distance() can return (or an upper bound). For unbounded state spaces...
void enforceBounds(State *state) const override
Bring the state within the bounds of the state space. For unbounded spaces this function can be a no-...
void sampleUniformNear(State *state, const State *near, double distance) override
Sample a state near another, within a neighborhood controlled by a distance parameter.
double * getValueAddressAtIndex(State *state, unsigned int index) const override
Many states contain a number of double values. This function provides a means to get the memory addre...
double minTime_
The minimum point in time considered by the state space (if bounds are used)
double distance(const State *state1, const State *state2) const override
Computes distance between two states. This function satisfies the properties of a metric if isMetricS...
bool isBounded() const
Check if the time is bounded or not.
State * allocState() const override
Allocate a state that can store a point in the described space.
void printSettings(std::ostream &out) const override
Print the settings for this state space to a stream.
const std::string & getName() const
Get the name of the state space.
Definition: StateSpace.cpp:196
double getMeasure() const override
Get a measure of the space (this can be thought of as a generalization of volume)
The definition of a time state.
void setName(const std::string &name)
Set the name of the state space.
Definition: StateSpace.cpp:201
int type_
A type assigned for this state space.
Definition: StateSpace.h:531
void interpolate(const State *from, const State *to, double t, State *state) const override
Computes the state that lies at time t in [0, 1] on the segment that connects from state to to state....
void sampleUniform(State *state) override
Sample a state.
double getMaxTimeBound() const
Get the maximum allowed value of position in a state. The function returns 0 if time is not bounded.
@ STATE_SPACE_TIME
ompl::base::TimeStateSpace
Abstract definition of a state space sampler.
Definition: StateSampler.h:65
void printState(const State *state, std::ostream &out) const override
Print a state to a stream.
A shared pointer wrapper for ompl::base::StateSampler.
bool satisfiesBounds(const State *state) const override
Check if a state is inside the bounding box. For unbounded spaces this function can always return tru...
TimeStateSampler(const StateSpace *space)
Constructor.
bool equalStates(const State *state1, const State *state2) const override
Checks whether two states are equal.
Main namespace. Contains everything in this library.
Definition: AppBase.h:22
void sampleGaussian(State *state, const State *mean, double stdDev) override
Sample a state using a Gaussian distribution with given mean and standard deviation (stdDev).
void registerProjections() override
Register the projections for this state space. Usually, this is at least the default projection....