/usr/lib/python2.7/dist-packages/pyevolve/GenomeBase.py is in python-pyevolve 0.6~rc1+svn398+dfsg-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 | """
:mod:`GenomeBase` -- the genomes base module
================================================================
This module have the class which every representation extends,
if you are planning to create a new representation, you must
take a inside look into this module.
"""
from random import choice as rand_choice
import inspect
from FunctionSlot import FunctionSlot
import Util
class GenomeBase:
""" GenomeBase Class - The base of all chromosome representation """
evaluator = None
""" This is the :term:`evaluation function` slot, you can add
a function with the *set* method: ::
genome.evaluator.set(eval_func)
"""
initializator = None
""" This is the initialization function of the genome, you
can change the default initializator using the function slot: ::
genome.initializator.set(Initializators.G1DListInitializatorAllele)
In this example, the initializator :func:`Initializators.G1DListInitializatorAllele`
will be used to create the initial population.
"""
mutator = None
""" This is the mutator function slot, you can change the default
mutator using the slot *set* function: ::
genome.mutator.set(Mutators.G1DListMutatorSwap)
"""
crossover = None
""" This is the reproduction function slot, the crossover. You
can change the default crossover method using: ::
genome.crossover.set(Crossovers.G1DListCrossoverUniform)
"""
def __init__(self):
"""Genome Constructor"""
self.evaluator = FunctionSlot("Evaluator")
self.initializator = FunctionSlot("Initializator")
self.mutator = FunctionSlot("Mutator")
self.crossover = FunctionSlot("Crossover")
self.internalParams = {}
self.score = 0.0
self.fitness = 0.0
def getRawScore(self):
""" Get the Raw Score of the genome
:rtype: genome raw score
"""
return self.score
def getFitnessScore(self):
""" Get the Fitness Score of the genome
:rtype: genome fitness score
"""
return self.fitness
def __repr__(self):
"""String representation of Genome"""
allSlots = self.allSlots = [ self.evaluator, self.initializator,
self.mutator, self.crossover ]
ret = "- GenomeBase\n"
ret+= "\tScore:\t\t\t %.6f\n" % (self.score,)
ret+= "\tFitness:\t\t %.6f\n\n" % (self.fitness,)
ret+= "\tParams:\t\t %s\n\n" % (self.internalParams,)
for slot in allSlots:
ret+= "\t" + slot.__repr__()
ret+="\n"
return ret
def setParams(self, **args):
""" Set the internal params
Example:
>>> genome.setParams(rangemin=0, rangemax=100, gauss_mu=0, gauss_sigma=1)
.. note:: All the individuals of the population shares this parameters and uses
the same instance of this dict.
:param args: this params will saved in every chromosome for genetic op. use
"""
self.internalParams.update(args)
def getParam(self, key, nvl=None):
""" Gets an internal parameter
Example:
>>> genome.getParam("rangemax")
100
.. note:: All the individuals of the population shares this parameters and uses
the same instance of this dict.
:param key: the key of param
:param nvl: if the key doesn't exist, the nvl will be returned
"""
return self.internalParams.get(key, nvl)
def resetStats(self):
""" Clear score and fitness of genome """
self.score = 0.0
self.fitness = 0.0
def evaluate(self, **args):
""" Called to evaluate genome
:param args: this parameters will be passes to the evaluator
"""
self.resetStats()
for it in self.evaluator.applyFunctions(self, **args):
self.score += it
def initialize(self, **args):
""" Called to initialize genome
:param args: this parameters will be passed to the initializator
"""
for it in self.initializator.applyFunctions(self, **args):
pass
def mutate(self, **args):
""" Called to mutate the genome
:param args: this parameters will be passed to the mutator
:rtype: the number of mutations returned by mutation operator
"""
nmuts = 0
for it in self.mutator.applyFunctions(self, **args):
nmuts+=it
return nmuts
def copy(self, g):
""" Copy the current GenomeBase to 'g'
:param g: the destination genome
.. note:: If you are planning to create a new chromosome representation, you
**must** implement this method on your class.
"""
g.score = self.score
g.fitness = self.fitness
g.evaluator = self.evaluator
g.initializator = self.initializator
g.mutator = self.mutator
g.crossover = self.crossover
#g.internalParams = self.internalParams.copy()
g.internalParams = self.internalParams
def clone(self):
""" Clone this GenomeBase
:rtype: the clone genome
.. note:: If you are planning to create a new chromosome representation, you
**must** implement this method on your class.
"""
newcopy = GenomeBase()
self.copy(newcopy)
return newcopy
class G1DBase:
""" G1DBase Class - The base class for 1D chromosomes
:param size: the 1D list size
.. versionadded:: 0.6
Added te *G1DBase* class
"""
def __init__(self, size):
self.genomeSize = size
self.genomeList = []
def __iadd__(self, item):
""" To add more items using the += operator """
self.genomeList.append(item)
return self
def __eq__(self, other):
""" Compares one chromosome with another """
cond1 = (self.genomeList == other.genomeList)
cond2 = (self.genomeSize == other.genomeSize)
return True if cond1 and cond2 else False
def __contains__(self, value):
""" Used on: *value in genome* """
return value in self.genomeList
def __getslice__(self, a, b):
""" Return the sliced part of chromosome """
return self.genomeList[a:b]
def __setslice__(self, a, b, val):
""" Sets the slice part of chromosome """
self.genomeList[a:b] = val
def __getitem__(self, key):
""" Return the specified gene of List """
return self.genomeList[key]
def __setitem__(self, key, value):
""" Set the specified value for an gene of List """
self.genomeList[key] = value
def __iter__(self):
""" Iterator support to the list """
return iter(self.genomeList)
def __len__(self):
""" Return the size of the List """
return len(self.genomeList)
def getListSize(self):
""" Returns the list supposed size
.. warning:: this is different from what the len(obj) returns
"""
return self.genomeSize
def resumeString(self):
""" Returns a resumed string representation of the Genome """
return str(self.genomeList)
def append(self, value):
""" Appends an item to the end of the list
Example:
>>> genome.append(44)
:param value: value to be added
"""
self.genomeList.append(value)
def remove(self, value):
""" Removes an item from the list
Example:
>>> genome.remove(44)
:param value: value to be added
"""
self.genomeList.remove(value)
def clearList(self):
""" Remove all genes from Genome """
del self.genomeList[:]
def copy(self, g):
""" Copy genome to 'g'
Example:
>>> genome_origin.copy(genome_destination)
:param g: the destination instance
"""
g.genomeSize = self.genomeSize
g.genomeList = self.genomeList[:]
def getInternalList(self):
""" Returns the internal list of the genome
... note:: this method was created to solve performance issues
:rtype: the internal list
"""
return self.genomeList
def setInternalList(self, lst):
""" Assigns a list to the internal list of the chromosome
:param lst: the list to assign the internal list of the chromosome
"""
self.genomeList = lst
class GTreeNodeBase:
""" GTreeNodeBase Class - The base class for the node tree genomes
:param parent: the parent node of the node
:param childs: the childs of the node, must be a list of nodes
.. versionadded:: 0.6
Added te *GTreeNodeBase* class
"""
def __init__(self, parent, childs=None):
self.parent = parent
self.childs = []
if childs is not None:
if type(childs) != list:
Util.raiseException("Childs must be a list of nodes", TypeError)
typecheck_list = filter(lambda x: not isinstance(x, GTreeNodeBase), childs)
if len(typecheck_list) > 0:
Util.raiseException("Childs must be a list of nodes", TypeError)
self.childs += childs
def isLeaf(self):
""" Return True if the node is a leaf
:rtype: True or False
"""
return len(self.childs)==0
def getChild(self, index):
""" Returns the index-child of the node
:rtype: child node
"""
return self.childs[index]
def getChilds(self):
""" Return the childs of the node
.. warning :: use .getChilds()[:] if you'll change the list itself, like using childs.reverse(),
otherwise the original genome child order will be changed.
:rtype: a list of nodes
"""
return self.childs
def addChild(self, child):
""" Adds a child to the node
:param child: the node to be added
"""
if type(child) == list:
self.childs.extend(child)
else:
if not isinstance(child, GTreeNodeBase):
Util.raiseException("The child must be a node", TypeError)
self.childs.append(child)
def replaceChild(self, older, newer):
""" Replaces a child of the node
:param older: the child to be replaces
:param newer: the new child which replaces the older
"""
index = self.childs.index(older)
self.childs[index] = newer
def setParent(self, parent):
""" Sets the parent of the node
:param parent: the parent node
"""
#if not isinstance(parent, GTreeNodeBase):
# Util.raiseException("The parent must be a node", TypeError)
self.parent = parent
def getParent(self):
""" Get the parent node of the node
:rtype: the parent node
"""
return self.parent
def __repr__(self):
parent = "None" if self.getParent() is None else "Present"
str_repr = "GTreeNodeBase [Childs=%d]" % len(self)
return str_repr
def __len__(self):
return len(self.childs)
def copy(self, g):
""" Copy the current contents GTreeNodeBase to 'g'
:param g: the destination node
.. note:: If you are planning to create a new chromosome representation, you
**must** implement this method on your class.
"""
g.parent = self.parent
g.childs = self.childs[:]
def clone(self):
""" Clone this GenomeBase
:rtype: the clone genome
.. note:: If you are planning to create a new chromosome representation, you
**must** implement this method on your class.
"""
newcopy = GTreeNodeBase(None)
self.copy(newcopy)
return newcopy
class GTreeBase:
""" GTreeBase Class - The base class for the tree genomes
:param root_node: the root node of the tree
.. versionadded:: 0.6
Added te *GTreeBase* class
"""
def __init__(self, root_node):
self.root_node = root_node
self.tree_height = None
self.nodes_list = None
def processNodes(self, cloning=False):
""" Creates a *cache* on the tree, this method must be called
every time you change the shape of the tree. It updates the
internal nodes list and the internal nodes properties such as
depth and height.
"""
if self.root_node is None: return
self.nodes_list = self.getAllNodes()
self.nodes_leaf = filter(lambda n: n.isLeaf(), self.nodes_list)
self.nodes_branch = filter(lambda n: n.isLeaf()==False, self.nodes_list)
if not cloning:
self.tree_height = self.getNodeHeight(self.getRoot())
def getRoot(self):
""" Return the tree root node
:rtype: the tree root node
"""
return self.root_node
def setRoot(self, root):
""" Sets the root of the tree
:param root: the tree root node
"""
if not isinstance(root, GTreeNodeBase):
Util.raiseException("The root must be a node", TypeError)
self.root_node = root
def getNodeDepth(self, node):
""" Returns the depth of a node
:rtype: the depth of the node, the depth of root node is 0
"""
if node==self.getRoot(): return 0
else: return 1 + self.getNodeDepth(node.getParent())
def getNodeHeight(self, node):
""" Returns the height of a node
.. note:: If the node has no childs, the height will be 0.
:rtype: the height of the node
"""
height = 0
if len(node) <= 0:
return 0
for child in node.getChilds():
h_inner = self.getNodeHeight(child)+1
if h_inner > height:
height = h_inner
return height
def getHeight(self):
""" Return the tree height
:rtype: the tree height
"""
return self.tree_height
def getNodesCount(self, start_node=None):
""" Return the number of the nodes on the tree
starting at the *start_node*, if *start_node* is None,
then the method will count all the tree nodes.
:rtype: the number of nodes
"""
count = 1
if start_node is None:
start_node = self.getRoot()
for i in start_node.getChilds():
count += self.getNodesCount(i)
return count
def getTraversalString(self, start_node=None, spc=0):
""" Returns a tree-formated string of the tree. This
method is used by the __repr__ method of the tree
:rtype: a string representing the tree
"""
str_buff = ""
if start_node is None:
start_node = self.getRoot()
str_buff += "%s\n" % start_node
spaces = spc + 2
for child_node in start_node.getChilds():
str_buff += "%s%s\n" % (" " * spaces, child_node)
str_buff += self.getTraversalString(child_node, spaces)
return str_buff
def traversal(self, callback, start_node=None):
""" Traversal the tree, this method will call the
user-defined callback function for each node on the tree
:param callback: a function
:param start_node: the start node to begin the traversal
"""
if not inspect.isfunction(callback):
Util.raiseException("The callback for the tree traversal must be a function", TypeError)
if start_node is None:
start_node = self.getRoot()
callback(start_node)
for child_node in start_node.getChilds():
callback(child_node)
self.traversal(callback, child_node)
def getRandomNode(self, node_type=0):
""" Returns a random node from the Tree
:param node_type: 0 = Any, 1 = Leaf, 2 = Branch
:rtype: random node
"""
lists = (self.nodes_list, self.nodes_leaf, self.nodes_branch)
cho = lists[node_type]
if len(cho) <= 0:
return None
return rand_choice(cho)
def getAllNodes(self):
""" Return a new list with all nodes
:rtype: the list with all nodes
"""
node_stack = []
all_nodes = []
tmp = None
node_stack.append(self.getRoot())
while len(node_stack) > 0:
tmp = node_stack.pop()
all_nodes.append(tmp)
childs = tmp.getChilds()
node_stack.extend(childs)
return all_nodes
def __repr__(self):
str_buff = "- GTree\n"
str_buff += "\tHeight:\t\t\t%d\n" % self.getHeight()
str_buff += "\tNodes:\t\t\t%d\n" % self.getNodesCount()
str_buff += "\n" + self.getTraversalString()
return str_buff
def __len__(self):
return len(self.nodes_list)
def __getitem__(self, index):
return self.nodes_list[index]
def __iter__(self):
return iter(self.nodes_list)
def copy(self, g, node=None, node_parent=None):
""" Copy the current contents GTreeBase to 'g'
:param g: the destination GTreeBase tree
.. note:: If you are planning to create a new chromosome representation, you
**must** implement this method on your class.
"""
if node is None:
g.tree_height = self.tree_height
node = self.root_node
if node is None: return None
newnode = node.clone()
if node_parent is None:
g.setRoot(newnode)
else:
newnode.setParent(node_parent)
node_parent.replaceChild(node, newnode)
for ci in xrange(len(newnode)):
GTreeBase.copy(self, g, newnode.getChild(ci), newnode)
return newnode
def clone(self):
""" Clone this GenomeBase
:rtype: the clone genome
.. note:: If you are planning to create a new chromosome representation, you
**must** implement this method on your class.
"""
newcopy = GTreeBase(None)
self.copy(newcopy)
newcopy.processNodes()
return newcopy
|