Map (boone)

java.lang.Object
- boone.structure.Layer
- - boone.structure.Map

All Implemented Interfaces:

Storable, java.lang.Cloneable

Direct Known Subclasses:

FilterMap, ForwardMap
```
public abstract class Map
extends Layer
implements java.lang.Cloneable
```
A map is a layer with depth 1. $Id$

Since:

December, 2021

Author:

Helmut A. Mayer

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`height` The height of this map.
`protected Link`	`link` The link type of the map.
`protected Neuron`	`neuron` The neuron type of the map.
`protected NeuronList`	`neurons` All the neurons in the map.
`protected int`	`width` The width of this map.

Constructor Summary

Constructors
Constructor and Description
`Map()` Constructs an empty map.
`Map(int width)` Generates a quadratic map of given width.
`Map(int width, int height)` Constructs a generic map with default neurons.
`Map(Map map)` Constructs a map copy.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Map`	`clone()` Returns a semi-deep clone of this map.
`boolean`	`connect(Layer other)` Connects this map with the given layer using the link type of this map.
`protected abstract boolean`	`connect(Map other)` Connects this map with the given map using the link type of this map.
`void`	`disconnect()` Disconnects the map from the previous layer.
`int`	`getDepth()` Returns the depth of this map.
`int`	`getHeight()` Returns the height of this map.
`int`	`getLinkCount()` Returns the the number of links into this map.
`Neuron`	`getNeuron(int i)` Returns the neuron with given index.
`protected Neuron`	`getNeuron(int row, int col)` Returns the neuron with given coordinates.
`NeuronList`	`getNeurons()` Returns the neurons in this map.
`int`	`getSize()` Returns the size of this map, i.e., the number of neurons.
`int`	`getWidth()` Returns the width of this map.
`void`	`reset()` Resets the internal state of this map (does nothing here).
`protected void`	`setIOType(boolean in, boolean out)` Sets the map neurons' IO status.
`java.lang.String`	`toString()` Returns the (width x height) of this map.
`org.jdom2.Element`	`toXML(org.jdom2.Element element)` Returns an XML element containing information on the layer.

Methods inherited from class boone.structure.Layer
addMap, addMap, fromXML, getLevel, getMapCount, getMaps, getNeuron, removeMap, setLevel

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - width
```
protected int width
```
    The width of this map.
  - height
```
protected int height
```
    The height of this map.
  - neuron
```
protected Neuron neuron
```
    The neuron type of the map.
  - link
```
protected Link link
```
    The link type of the map.
  - neurons
```
protected NeuronList neurons
```
    All the neurons in the map. The neurons' order is based on a linearized matrix. The first row with index 0 starts the list. All other rows follow. Rows and columns start with index 0.
- Constructor Detail
  - Map
```
public Map()
```
    Constructs an empty map.
  - Map
```
public Map(Map map)
```
    Constructs a map copy. The neurons in the map and all the links are cloned. The links are set up according to the original map. However, sink or source of the links are only set, if the original neuron was also sink or source. If the link was connected to a non-map neuron, it is not connected in the cloned map.
    
    Parameters:
    
    map - the map to be copied
  - Map
```
public Map(int width)
```
    Generates a quadratic map of given width.
    
    Parameters:
    
    width - the square width
  - Map
```
public Map(int width,
           int height)
```
    Constructs a generic map with default neurons.
    
    Parameters:
    
    width - the width
    
    height - the height
- Method Detail
  - clone
```
public Map clone()
```
    Returns a semi-deep clone of this map.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    the clone
  - reset
```
public void reset()
```
    Resets the internal state of this map (does nothing here).
  - getWidth
```
public int getWidth()
```
    Returns the width of this map.
    
    Overrides:
    
    getWidth in class Layer
    
    Returns:
    
    the width
  - getHeight
```
public int getHeight()
```
    Returns the height of this map.
    
    Overrides:
    
    getHeight in class Layer
    
    Returns:
    
    the height
  - getDepth
```
public int getDepth()
```
    Returns the depth of this map.
    
    Overrides:
    
    getDepth in class Layer
    
    Returns:
    
    the depth, always 1
  - getSize
```
public int getSize()
```
    Returns the size of this map, i.e., the number of neurons.
    
    Overrides:
    
    getSize in class Layer
    
    Returns:
    
    the size
  - getNeurons
```
public NeuronList getNeurons()
```
    Returns the neurons in this map.
    
    Overrides:
    
    getNeurons in class Layer
    
    Returns:
    
    the list of neurons
  - getNeuron
```
public Neuron getNeuron(int i)
```
    Returns the neuron with given index.
    
    Returns:
    
    the neuron
  - getNeuron
```
protected Neuron getNeuron(int row,
                           int col)
```
    Returns the neuron with given coordinates.
    
    Parameters:
    
    row - the row of the neuron (0 to width - 1)
    
    col - the column of the neuron (0 to height - 1)
    
    Returns:
    
    the neuron
  - getLinkCount
```
public int getLinkCount()
```
    Returns the the number of links into this map.
    
    Overrides:
    
    getLinkCount in class Layer
    
    Returns:
    
    the number of incoming links
  - setIOType
```
protected void setIOType(boolean in,
                         boolean out)
```
    Sets the map neurons' IO status. Note that a default input neuron is set to not using the bias and having an identity activation function.
    
    Overrides:
    
    setIOType in class Layer
    
    Parameters:
    
    in - true, if in input layer
    
    out - true, if in output layer
  - connect
```
public boolean connect(Layer other)
```
    Connects this map with the given layer using the link type of this map. This map is connected to each map/channel from the other layer. Note that this may result in a very large number of connections.
    
    Overrides:
    
    connect in class Layer
    
    Parameters:
    
    other - another layer
    
    Returns:
    
    true, if some connection has been made
  - disconnect
```
public void disconnect()
```
    Disconnects the map from the previous layer. The disconnected links are dangling and set to being not trainable.
    
    Overrides:
    
    disconnect in class Layer
  - toXML
```
public org.jdom2.Element toXML(org.jdom2.Element element)
```
    Returns an XML element containing information on the layer.
    
    Specified by:
    
    toXML in interface Storable
    
    Overrides:
    
    toXML in class Layer
    
    Parameters:
    
    element - the parent element
    
    Returns:
    
    the layer element
  - toString
```
public java.lang.String toString()
```
    Returns the (width x height) of this map.
    
    Overrides:
    
    toString in class Layer
    
    Returns:
    
    the string expression
  - connect
```
protected abstract boolean connect(Map other)
```
    Connects this map with the given map using the link type of this map.
    
    Parameters:
    
    other - another map
    
    Returns:
    
    true, if successful

Class Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class boone.structure.Layer

Methods inherited from class java.lang.Object

Field Detail

width

height

neuron

link

neurons

Constructor Detail

Map

Map

Map

Map

Method Detail

clone

reset

getWidth

getHeight

getDepth

getSize

getNeurons

getNeuron

getNeuron

getLinkCount

setIOType

connect

disconnect

toXML

toString

connect