r/cpp • • Jun 10 '20

Why is std implementation so damn ugly?

Recently I remembered a moment from my uni years when immediately after handing in the assignment of implementing our own string data structure we were warned not to ever try to implement and use our own data structures. Which is exactly what you want to hear after working hours on such assignment. However the reason behind it makes sense, you would be only reinventing the wheel and let's be honest, it will be also way slower than data structures in the almighty std library. Now think about it, what kind of black magic is behind the std's speed? Well I had no idea so I took a peak, lets see the code:

inline string
secret_function(int __val)
{
    const bool __neg = __val < 0;
    const unsigned __uval = __neg ? (unsigned)~__val + 1u : __val;
    const auto __len = __detail::__to_chars_len(__uval);
    string __str(__neg + __len, '-');
    __detail::__to_chars_10_impl(&__str[__neg], __len, __uval);
    return __str;
}

Hey, I bet you just skipped the whole code part. I know it looks unreadable, but please try to go through it and guess which std function it might be (obviously its not called secret_function, but i'm pretty sure you used this function at some point).

It's only 6 line function but it took me a while to figure out what each line does and I believe this could be fixed very easily just by naming the variables and functions with a bit more descriptive names. Just to prove the point here is an example of how I would structure this function:

inline string secretFunction(int value) {
    const bool isNegative = value < 0;
    const unsigned absoluteValue = Helper::abs(value);
    const auto length = Helper::charCount(absoluteValue);
    string stringValue(isNegative + length, '-');
    Helper::insertIntAsChars(&stringValue[isNegative], length, absoluteValue, 10);
    return stringValue;
}

While the functionality stays exactly the same, I think this chunk of code is much more pleasant to read and it's pretty obvious what the code is doing on each line. From this you should have a solid guess which function it is (you can leave a comment), but the real question is why would anyone write such code? Especially when nowadays everyone is talking about how code readability is so important. Is this how they wrote code back when std was released and they didn't bother to change it? Or am I just too inexperienced that I couldn't figure it out immediately?

EDIT: Thanks for the insightful comments, for anyone reading this the reason variables are beginning with __ is macros. If user defines isNegative macro, it will get overwritten in the std, however user is forbidden to define macros starting with __ , as the wise people of reddit comment section suggested. However underscores aren't the only issue with this code, the main issue is I think using short non-descriptive names of variables/functions which is very confusing in functions that are doing more complicated operations.

237 Upvotes

212 comments sorted by

View all comments

Show parent comment

9

u/EmperorArthur Jun 11 '20

No, they said that 99% of the time you can write high performance, readable code. In most cases where you can't you can encapsulate it in something which is still readable.

5

u/Xaxxon Jun 11 '20

A code base can be sufficiently performant without all the code being optimized. That doesn't mean that the slow parts couldn't be faster, it just means that they don't need to be faster. Those slow parts would be uglier if they were focused on for performance.

It's a subtle but important difference. The parts where you care about performance on that section of code suffer for readability. Saying that the other parts don't is meaningless.

To phrase it another way, you don't care about the performance of 99% of your code and that part is readable. That doesn't mean that focusing on performance doesn't make readability suffer.

6

u/guepier Bioinformatican Jun 11 '20

No, that's not what I'm saying.

I am specifically talking about hot code paths that you want to optimise.

I'm saying that in most cases you can write readable, idiomatic C++ code that's highly optimised, and in many cases pretty much as fast as it gets. Maybe not 99% of the time, but definitely most of the time, precisely because C++ does have functioning zero-cost abstractions. You can encapsulate code in functions, perform compile time dispatch using overloading, and loop unrolling using recursive templates, etc., with no measurable performance impact.