sc::SCExtrapError(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

✨ sc::SCExtrapError(3) ✨

okay so bestie, welcome to sc::SCExtrapError(3) from the MPQC manual 💖 This page is literally all about the little error-data holder that SelfConsistentExtrapolation needs, and it's giving "small but important" main-character energy. 🫶

🌸 NAME 🌸

sc::SCExtrapError — SCExtrapError holds the error data needed by SelfConsistentExtrapolation. That's the whole vibe: error data, but make it savable. 💅

✨ SYNOPSIS ✨

#include <scextrap.h>

Inherits sc::SavableState.

Inherited by sc::SymmSCMatrixSCExtrapError.

💖 Public Member Functions 💖

  • SCExtrapError () — construct a brand-new SCExtrapError. Fresh out of the box, no cap. ✨
  • SCExtrapError (StateIn &) — constructor that restores an SCExtrapError from a StateIn object. It's giving "bring me back from the save file" energy. 🎀
  • void save_data_state (StateOut &) — save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. More on this in the member function section, bestie. 💾
  • virtual double error ()=0 — returns some measure of the total error. Pure virtual, so the derived class has to bring the actual formula. 👑
  • virtual double scalar_product (const Ref< SCExtrapError > &)=0 — performs a scalar product between this and the given SCExtrapError. Also pure virtual. 🦋

🧚 Additional Inherited Members 🧚

This section is present, but there's no extra inherited-member content listed here. It's giving placeholder energy, and honestly? Respect. 🫶

💜 Detailed Description 💜

SCExtrapError holds the error data needed by SelfConsistentExtrapolation. That's it, that's the whole plot. It is the error-data container bestie. 🍓

📚 Member Function Documentation 📚

🌈 void sc::SCExtrapError::save_data_state (StateOut &) [virtual] 🌈

Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. This must be implemented by the derived class if the class has data. 🔥

  • Reimplemented from sc::SavableState.
  • Reimplemented in sc::SymmSCMatrixSCExtrapError.

🌟 Author 🌟

Generated automatically by Doxygen for MPQC from the source code. Yes bestie, even the docs have lore. 💀

Version 2.3.1, dated Sun Oct 4 2020 — that's the footer tea, periodt. 💅✨

📦 where this page comes from