Package esys :: Package lsm :: Module LsmPy :: Class ParticleIdPair
[hide private]
[frames] | no frames]

Class ParticleIdPair

 object --+    
          |    
??.instance --+
              |
             ParticleIdPair

Pair of particle Id's.

Instance Methods [hide private]
 
__eq__(...)
 
__getinitargs__(...)
 
__getitem__(...)
Returns id of indexed element.
 
__hash__(...)
hash(x)
 
__init__(...)
Construct pair with specified id's.
int
__len__(...)
Returns 2.
 
__lt__(...)
 
__reduce__(...)
helper for pickle

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __instance_size__ = 24
  __safe_for_unpickling__ = True
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__getitem__(...)
(Indexing operator)

 

Returns id of indexed element.

Parameters:
  • idx (int) - index value 0 or 1.

__hash__(...)
(Hashing function)

 

hash(x)

Overrides: object.__hash__
(inherited documentation)

__init__(...)
(Constructor)

 

Construct pair with specified id's.

Parameters:
  • id1 (int) - Particle Id.
  • id2 (int) - Particle Id.
Overrides: object.__init__

__len__(...)
(Length operator)

 

Returns 2.

Returns: int
length of pair (always 2).

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)