sc::CorrelationTable(3)

๐Ÿ“ฆ
version 2.3.1 ยท 5 versions
, in ubuntu jammy

๐Ÿ’– NAME ๐Ÿ’–

okay so bestie, this is sc::CorrelationTable(3) from the MPQC manual โ€” and the whole vibe is: sc::CorrelationTable is the class that provides a correlation table between two point groups. That's the main character energy right there. No cap. โœจ


โœจ SYNOPSIS โœจ

#include <corrtab.h>

And yes, it Inherits sc::RefCount โ€” inherited realness, periodt. ๐Ÿ’…

๐ŸŒธ Public Member Functions ๐ŸŒธ

  • CorrelationTable (const Ref< PointGroup > &group, const Ref< PointGroup > &subgroup) โ€” creates a correlation table for the two groups. slay.
  • Ref< PointGroup > group () const โ€” hands you back the higher order point group. iconic.
  • Ref< PointGroup > subgroup () const โ€” hands you back the lower order point group. yes bestie.
  • int initialize_table (const Ref< PointGroup > &group, const Ref< PointGroup > &subgroup) โ€” โ€œInitalizeโ€ (spelling exactly as the original says it, donโ€™t come for me) the correlation table. The detailed tea is below ๐Ÿ‘€
  • const char * error (int errcod) โ€” converts error codes from initialize_table into a text string. helpful king.
  • int n () const โ€” returns the number of irreps in the high order group.
  • int subn () const โ€” returns the number of irreps in the subgroup.
  • int degen (int igamma) const โ€” returns the degeneracy of the irrep.
  • int subdegen (int igamma) const โ€” returns the degeneracy of the subgroup irrep.
  • int ngamma (int igamma) const โ€” returns the number of irreps in the low order group that an irrep. (thatโ€™s literally the original wording โ€” Iโ€™m not adding lore) ๐Ÿ‘€
  • int gamma (int igamma, int i) const โ€” returns the irreps in the low order group that an irrep from the high order group can be reduced to. we love a reduction moment ๐Ÿ’…
  • void print (std::ostream &o=ExEnv::out0()) const โ€” the original gives no description here, just this exact signature with the default ExEnv::out0(). respect the mystery ๐Ÿซถ

๐ŸŽ€ Additional Inherited Members ๐ŸŽ€

nothing extra listed here โ€” the inherited bits are just doing their inherited thing. ๐Ÿ’…


๐Ÿฆ‹ Detailed Description ๐Ÿฆ‹

The CorrelationTable class provides a correlation table between two point groups.

thatโ€™s the whole detailed description, and honestly? it ate. โœจ


๐Ÿ“š Member Function Documentation ๐Ÿ“š

๐Ÿงฎ sc::CorrelationTable::initialize_table

int sc::CorrelationTable::initialize_table (const Ref< PointGroup > & group,
    const Ref< PointGroup > & subgroup)

Initalize the correlation table. Returns 0 for success and nonzero for failure. This will fail if the subgroup is not really a subgroup of group. so like, check your subgroup before you come in here, bestie. ๐Ÿ’€


๐Ÿ‘‘ Author ๐Ÿ‘‘

Author: Generated automatically by Doxygen for MPQC from the source code.

ngl thatโ€™s the most lowkey flex โ€” auto-generated by Doxygen for MPQC straight from the source code. ๐ŸŽ€


๐Ÿ’– Version 2.3.1 โ€” Sun Oct 4 2020 โ€” thatโ€™s the whole sc::CorrelationTable(3) page from the MPQC manual, bestie. mwah, bye ๐Ÿซถโœจ

๐Ÿ“ฆ where this page comes from