sc::SCException(3)

πŸ“¦
version 2.3.1 Β· 5 versions
, in ubuntu jammy

πŸ’… sc::SCException(3) πŸ’…

okay so bestie, you're reading the manual page for sc::SCException from MPQC, and honestly? this one is lowkey the emotional support exception of the whole library. let's get into it ✨


🌸 NAME 🌸

sc::SCException β€” it's a std::exception specialization that literally records the info about where an exception went down. like a little receipt for your crash, no cap πŸ§ΎπŸ’€


✨ SYNOPSIS ✨

#include <scexception.h>

Inherits exception.

Inherited by sc::AlgorithmException, sc::InputError, sc::LimitExceeded<T>, sc::ProgrammingError, and sc::SystemException. she's the mother of them all, fr fr πŸ‘‘

πŸŽ€ Public Member Functions πŸŽ€

  • SCException(const char *description=0, const char *file=0, int line=0, const ClassDesc *class_desc=0, const char *exception_type='SCException') throw() β€” the main constructor, defaults and all, exactly as written πŸ‘‘
  • SCException(const SCException &) throw() β€” copy constructor, because sometimes one exception just needs a twin 🫢
  • const char *what() const throw() β€” reimplementation of std::exception::what()
  • const char *description() const throw() β€” hands you the description string
  • const char *file() const throw() β€” tells you which file the drama happened in
  • int line() const throw() β€” gives you that line number ✨
  • const ClassDesc *class_desc() const throw() β€” returns the class description pointer
  • const char *exception_type() const throw() β€” tells you what kind of exception this is
  • std::ostream &elaborate() β€” returns a stream where you can write additional info about the exception πŸ’–

πŸ¦‹ Detailed Description πŸ¦‹

this is a std::exception specialization that records information about where an exception took place. that's it, that's the vibe. she's iconic for it, periodt πŸ’…


🌈 Member Function Documentation 🌈

⭐ std::ostream& sc::SCException::elaborate()

returns a stream where addition information about the exception can be written. heads up though β€” this will throw if a valid stream cannot be returned (possibly due to low memory). so like, respect the memory situation bestie 😭

⭐ const char* sc::SCException::what() const

reimplementation of std::exception::what(). the returned std::string is only valid for the lifetime of this object β€” do not go holding onto it after the object dips, that's giving undefined behaviour energy πŸ’€


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code. so nobody actually hand-wrote this one, the robots ate πŸ€–βœ¨


ok that's the whole page bestie, every flag, every signature, every warning β€” nothing skipped, nothing invented 🫢

πŸŽ€ sign-off time: this was Version 2.3.1, dated Sun Oct 4 2020, and it's sc::SCException(3) all day every day. slay πŸ’–πŸŒΈ

πŸ“¦ where this page comes from