Package parsimony :: Package utils :: Module start_vectors :: Class IdentityStartVector
[hide private]
[frames] | no frames]

Class IdentityStartVector

source code

     object --+    
              |    
BaseStartVector --+
                  |
                 IdentityStartVector

A pre-determined start vector.

Parameters
----------
vector : Numpy array. The predetermined start vector

Examples
--------
>>> from parsimony.utils.start_vectors import IdentityStartVector
>>> start_vector = IdentityStartVector(np.array([[0.5], [2.0], [0.3],
...                                              [1.0]]))
>>> start_vector.get_vector()
array([[ 0.5],
       [ 2. ],
       [ 0.3],
       [ 1. ]])

Nested Classes [hide private]

Inherited from BaseStartVector: __metaclass__

Instance Methods [hide private]
 
__init__(self, vector, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
get_vector(self, *args, **kwargs)
Return the predetermined start vector
source code

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

Class Variables [hide private]
  __abstractmethods__ = frozenset([])
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, vector, **kwargs)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

get_vector(self, *args, **kwargs)

source code 
Return the predetermined start vector

Examples
--------
>>> from parsimony.utils.start_vectors import IdentityStartVector
>>> start_vector = IdentityStartVector(np.array([[0.5], [2.0], [0.3],
...                                              [1.0]]))
>>> start_vector.get_vector()
array([[ 0.5],
       [ 2. ],
       [ 0.3],
       [ 1. ]])

Overrides: BaseStartVector.get_vector