GCC Code Coverage Report


Directory: ./
File: include/hpp/core/configuration-shooter.hh
Date: 2024-12-13 16:14:03
Exec Total Coverage
Lines: 8 8 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_CONFIGURATION_SHOOTER_HH
31 #define HPP_CORE_CONFIGURATION_SHOOTER_HH
32
33 #include <hpp/core/config.hh>
34 #include <hpp/core/fwd.hh>
35
36 namespace hpp {
37 namespace core {
38 /// \addtogroup configuration_sampling
39 /// \{
40
41 /// Abstraction of configuration shooter
42 ///
43 /// Configuration shooters are used by random sampling algorithms to
44 /// generate new configurations
45 class HPP_CORE_DLLAPI ConfigurationShooter {
46 public:
47 /// Shoot a random configuration
48 4009 virtual Configuration_t shoot() const {
49 4009 Configuration_t q;
50
1/2
✓ Branch 1 taken 4009 times.
✗ Branch 2 not taken.
4009 shoot(q);
51 4009 return q;
52 }
53
54 /// Shoot a random configuration
55 /// \param q the configuration (resized if necessary).
56 ///
57 /// \deprecated This method is virtual for backward compatibility. It will
58 /// become non-virtual in the future. Child classes should rather implement
59 /// \ref impl_shoot so that both prototype of method shoot remain available.
60 4264 virtual void shoot(Configuration_t& q) const { impl_shoot(q); }
61
62 100 virtual ~ConfigurationShooter() {};
63
64 protected:
65 59 ConfigurationShooter() {}
66 /// Store weak pointer to itself
67 59 void init(const ConfigurationShooterWkPtr_t& weak) { weakPtr_ = weak; }
68
69 virtual void impl_shoot(Configuration_t& q) const = 0;
70
71 private:
72 ConfigurationShooterWkPtr_t weakPtr_;
73 }; // class
74 } // namespace core
75 /// \}
76 } // namespace hpp
77 #endif // HPP_CORE_CONFIGURATION_SHOOTER_HH
78