std::valarray::min(3)

💖 NAME 💖

Okay bestie, this is the std::valarray::min(3) page from the C++ Standard Libary manpage set — yes, “Libary” is literally how it’s written up there, and I’m leaving it exactly as-is 💅.

std::valarray::min — and the name is literally std::valarray::min. No cap, that’s the whole NAME section.

✨ Synopsis ✨

Signature, served fresh:

T min() const;

This computes the minimum value of the elements. Very “find the smallest one and slay,” lowkey. 🌸

If there are no elements, the behavior is undefined. That’s not a cute mysterious vibe — it’s undefined behavior, bestie, so please do not call this on an empty valarray and expect main-character safety. 😭

The function can be used only if operator< is defined for type T. Like, no operator< for T, no min. Periodt. 💅

🎀 Parameters 🎀

(none) — zero parameters. Not a single one. The parameter section is empty and thriving. 🫶

🌸 Return value 🌸

The minimum of the elements. That’s it. That’s the return value. 💖

🦋 Example 🦋

The page says // Run this code, so here’s the exact code:

// Run this code

#include <valarray>
#include <iostream>

int main()
{
    std::valarray<double> a{1, 2, 3, 4, 5, 6, 7, 8};
    std::cout << "Minimum value : " << a.min() << "\n";
}

🍓 Output 🍓

Minimum value : 1

💜 See also 💜

• max — returns the largest element (public member function). The iconic opposite-energy bestie to min. 👑

That’s the whole page, bestie — source: http://cppreference.com, version/date: 2024.06.10. Stay cozy, check your empties, and may your valarray always be non-empty. 💅✨🎀