inversion_ideas.base.MinimizerResult

class inversion_ideas.base.MinimizerResult

Dictionary to store results of a single minimization iteration.

This class is a child of dict, but allows to access the values through attributes.

Methods

clear(/)	Remove all items from the dict.
copy(/)	Return a shallow copy of the dict.
fromkeys(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items(/)	Return a set-like object providing a view on the dict's items.
keys(/)	Return a set-like object providing a view on the dict's keys.
pop(key[, default])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem(/)	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values(/)	Return an object providing a view on the dict's values.

Notes

Inspired in the scipy.optimize.OptimizeResult.

Methods

Methods documentation

MinimizerResult.clear(/)

Remove all items from the dict.

---

MinimizerResult.copy(/)

Return a shallow copy of the dict.

---

classmethod MinimizerResult.fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

---

MinimizerResult.get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

---

MinimizerResult.items(/)

Return a set-like object providing a view on the dict’s items.

---

MinimizerResult.keys(/)

Return a set-like object providing a view on the dict’s keys.

---

MinimizerResult.pop(key, default=<unrepresentable>, /)

If the key is not found, return the default if given; otherwise, raise a KeyError.

---

MinimizerResult.popitem(/)

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

---

MinimizerResult.setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

---

MinimizerResult.update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

---

MinimizerResult.values(/)

Return an object providing a view on the dict’s values.

---