IGLib  1.5
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Meta.Numerics.Spin.SpinState Struct Reference

Represents the state of a spinor. More...

+ Collaboration diagram for Meta.Numerics.Spin.SpinState:

Public Member Functions

 SpinState (double j, double m)
 Instantiates a new SpinState with the given spin and magnetic quantum numbers. More...
 
 SpinState (Spin s, double m)
 Instantiates a new SpinState with the given spin and magnetic quantum number. More...
 
override bool Equals (object obj)
 Determines whether the given object represents the same spin state. More...
 
override int GetHashCode ()
 Computes a hash function for the spin state. More...
 
override string ToString ()
 Produces a string representation of the spin state. More...
 

Static Public Member Functions

static bool operator== (SpinState s1, SpinState s2)
 Determines whether two spin states are equal. More...
 
static bool operator!= (SpinState s1, SpinState s2)
 Determines whether two spin states are unequal. More...
 

Properties

double J [get]
 Gets the spin value of the spin state. More...
 
double M [get]
 Gets the magnetic substate value of the spin state. More...
 
Spin Representation [get]
 Gets the spinor representation to which the spin state belongs. More...
 

Static Private Member Functions

static bool Equals (SpinState s1, SpinState s2)
 
static string SpinString (int twoJ)
 

Private Attributes

Spin spin
 
int twoM
 

Detailed Description

Represents the state of a spinor.

Constructor & Destructor Documentation

Meta.Numerics.Spin.SpinState.SpinState ( double  j,
double  m 
)
inline

Instantiates a new SpinState with the given spin and magnetic quantum numbers.

Parameters
jThe spin number.
mThe magnetic number.
Meta.Numerics.Spin.SpinState.SpinState ( Spin  s,
double  m 
)
inline

Instantiates a new SpinState with the given spin and magnetic quantum number.

Parameters
sThe spin.
mThe magnetic quantum number.

Member Function Documentation

static bool Meta.Numerics.Spin.SpinState.Equals ( SpinState  s1,
SpinState  s2 
)
inlinestaticprivate
static bool Meta.Numerics.Spin.SpinState.operator== ( SpinState  s1,
SpinState  s2 
)
inlinestatic

Determines whether two spin states are equal.

Parameters
s1The first spin state.
s2The second spin state.
Returns
True if s1 and s2 are equal, otherwise false.
static bool Meta.Numerics.Spin.SpinState.operator!= ( SpinState  s1,
SpinState  s2 
)
inlinestatic

Determines whether two spin states are unequal.

Parameters
s1The first spin state.
s2The second spin state.
Returns
False if s1 and s2 are equal, otherwise true.
override bool Meta.Numerics.Spin.SpinState.Equals ( object  obj)
inline

Determines whether the given object represents the same spin state.

Parameters
objThe object to compare.
Returns
True if obj is an equal spin state, otherwise false.
override int Meta.Numerics.Spin.SpinState.GetHashCode ( )
inline

Computes a hash function for the spin state.

Returns
An integer which is guaranteed equal for equal spin states, an unlikely to be equal for unequal spin states.
override string Meta.Numerics.Spin.SpinState.ToString ( )
inline

Produces a string representation of the spin state.

Returns
A string representation of the spin state.

References Meta.Numerics.Spin.Spin.ToString().

static string Meta.Numerics.Spin.SpinState.SpinString ( int  twoJ)
inlinestaticprivate

Member Data Documentation

Spin Meta.Numerics.Spin.SpinState.spin
private
int Meta.Numerics.Spin.SpinState.twoM
private

Property Documentation

Spin Meta.Numerics.Spin.SpinState.Representation
get

Gets the spinor representation to which the spin state belongs.


The documentation for this struct was generated from the following file: