GCC Code Coverage Report


Directory: ./
File: include/hpp/core/weighed-distance.hh
Date: 2024-12-13 16:14:03
Exec Total Coverage
Lines: 1 1 100.0%
Branches: 1 2 50.0%

Line Branch Exec Source
1 //
2 // Copyright (c) 2014 CNRS
3 // Authors: Florent Lamiraux
4 //
5
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions are
8 // met:
9 //
10 // 1. Redistributions of source code must retain the above copyright
11 // notice, this list of conditions and the following disclaimer.
12 //
13 // 2. Redistributions in binary form must reproduce the above copyright
14 // notice, this list of conditions and the following disclaimer in the
15 // documentation and/or other materials provided with the distribution.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
28 // DAMAGE.
29
30 #ifndef HPP_CORE_WEIGHED_DISTANCE_HH
31 #define HPP_CORE_WEIGHED_DISTANCE_HH
32
33 #include <hpp/core/distance.hh>
34
35 namespace hpp {
36 namespace core {
37 /// \addtogroup steering_method
38 /// \{
39
40 /// Weighed distance between configurations
41 ///
42 /// Euclidean distance between configurations seen as vectors.
43 /// Each degree of freedom is weighed by a positive value.
44 class HPP_CORE_DLLAPI WeighedDistance : public Distance {
45 public:
46 static WeighedDistancePtr_t createFromProblem(
47 const ProblemConstPtr_t& problem);
48 static WeighedDistancePtr_t create(const DevicePtr_t& robot);
49 static WeighedDistancePtr_t createWithWeight(const DevicePtr_t& robot,
50 const vector_t& weights);
51 static WeighedDistancePtr_t createCopy(const WeighedDistancePtr_t& distance);
52 virtual DistancePtr_t clone() const;
53 /// Get weight of joint at given rank
54 /// \param rank rank of the joint in robot joint vector
55 value_type getWeight(size_type rank) const;
56 /// Set weight of joint at given rank
57 /// \param rank rank of the joint in robot joint vector
58 void setWeight(size_type rank, value_type weight);
59 /// Get weights
60 const vector_t& weights() const;
61 /// Set weights
62 void weights(const vector_t& ws);
63 /// Get size of weight vector
64 size_type size() const { return weights_.size(); }
65
66 /// Get robot
67 const DevicePtr_t& robot() const { return robot_; }
68
69 protected:
70 WeighedDistance(const ProblemConstPtr_t& problem);
71 WeighedDistance(const DevicePtr_t& robot);
72 WeighedDistance(const DevicePtr_t& robot, const vector_t& weights);
73 WeighedDistance(const WeighedDistance& distance);
74 void init(WeighedDistanceWkPtr_t self);
75 /// Derived class should implement this function
76 virtual value_type impl_distance(ConfigurationIn_t q1,
77 ConfigurationIn_t q2) const;
78 /// For serialization only.
79
1/2
✓ Branch 3 taken 3 times.
✗ Branch 4 not taken.
3 WeighedDistance() {}
80
81 private:
82 void computeWeights();
83 DevicePtr_t robot_;
84 vector_t weights_;
85 WeighedDistanceWkPtr_t weak_;
86
87 HPP_SERIALIZABLE();
88 }; // class WeighedDistance
89 /// \}
90 } // namespace core
91 } // namespace hpp
92 #endif // HPP_CORE_WEIGHED_DISTANCE_HH
93