search

envire / envire-envire_core

Core part for the Environment Representation library
BSD 2-Clause "Simplified" License
7 stars 13 forks source link

Typo in Graph #23

Closed AlexanderFabisch closed 6 years ago

AlexanderFabisch commented 7 years ago

There is a function called breathFirstSearch() (d is missing). Seems like the graph is drowning? :)

arneboe commented 7 years ago

yes, under the hood the graph is a whale that needs to breath occasionally. You should call this method before performing longer searches. Otherwise the whale might drown while searching.

AlexanderFabisch commented 7 years ago

That makes sense. :) Reminds me of The Beast Below.

arneboe commented 7 years ago

seriously though, I dont know if we can rename the method. It might be used in a lot of places?

chhtz commented 7 years ago

We could rename the method and add an deprecated alias with the old name

AlexanderFabisch commented 7 years ago

That's what I would suggest. Probably there is some C++ magic to generate compiler warnings if the old method is used and you can print some runtime warning.

arneboe commented 7 years ago

[[deprecated]] is available in c++14. can we bump envire to c++14? :)

chhtz commented 7 years ago

gcc/clang have __attribute__((deprecated)). MSVC has __declspec(deprecated). These are the alternatives EIGEN_DEPRECATED currently evaluates to.

arneboe commented 7 years ago

EIGEN_DEPRECATED sounds good

chhtz commented 6 years ago

Fixed: https://github.com/envire/envire-envire_core/commit/ff8d7685fba495c52dc9b9fad1b7794869eabd41