GQCP::JacobiRotation Class Reference

#include <JacobiRotation.hpp>

Collaboration diagram for GQCP::JacobiRotation:

Public Member Functions
	JacobiRotation (const size_t p, const size_t q, const double angle)
	JacobiRotation ()
double	angle () const
size_t	p () const
size_t	q () const
Eigen::JacobiRotation< double >	Eigen () const

Friends
std::ostream &	operator<< (std::ostream &os, const JacobiRotation &jacobi_rotation)

Detailed Description

A type that encapsulates the parameters that define a real-valued Jacobi rotation.

Constructor & Destructor Documentation

JacobiRotation() [1/2]

GQCP::JacobiRotation::JacobiRotation	(	const size_t	p,
		const size_t	q,
		const double	angle
	)

Parameters

p	The index of the first rotated orbital. (p > q)
q	The index of the second rotated orbital. (p > q)
angle	The angle of rotation, in radians.

JacobiRotation() [2/2]

GQCP::JacobiRotation::JacobiRotation

(

)

The default constructor.

Member Function Documentation

angle()

double GQCP::JacobiRotation::angle ( ) const

inline

Returns

The angle of rotation, in radians

Eigen()

Eigen::JacobiRotation< double > GQCP::JacobiRotation::Eigen ( ) const

inline

Returns

This as an Eigen::JacobiRotation.

p()

size_t GQCP::JacobiRotation::p ( ) const

inline

Returns

The index of the first rotated orbital. (p > q)

q()

size_t GQCP::JacobiRotation::q ( ) const

inline

Returns

The index of the second rotated orbital. (p > q)

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const JacobiRotation &  jacobi_rotation  )

friend

Parameters

os	The output stream which the parameters should be concatenated to.
jacobi_rotation	The Jacobi rotation.

Returns

A reference to the updated output stream.

---

The documentation for this class was generated from the following files:

• /__w/GQCP/GQCP/gqcp/include/Basis/Transformations/JacobiRotation.hpp
• /__w/GQCP/GQCP/gqcp/src/Basis/Transformations/JacobiRotation.cpp