com.xilinx.rapidwright.device.helper

Class TileColumnPattern

Object

AbstractCollection<E>

AbstractList<E>

ArrayList<TileTypeEnum>

com.xilinx.rapidwright.device.helper.TileColumnPattern

All Implemented Interfaces:

Serializable, Cloneable, Comparable<TileColumnPattern>, Iterable<TileTypeEnum>, Collection<TileTypeEnum>, List<TileTypeEnum>, RandomAccess

public class TileColumnPattern
extends ArrayList<TileTypeEnum>
implements Comparable<TileColumnPattern>

Represents a pattern of tile columns found on a Xilinx device. Created on: Jun 2, 2016

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PATTERN_LENGTH
static int	NULL_COLUMN_BREAK_SIZE The number of consecutive NULL columns for a pattern not to cross

Constructor Summary

Constructors

Constructor and Description
TileColumnPattern()

Method Summary

Modifier and Type	Method and Description
int	compareTo(TileColumnPattern o)
static TileColumnPattern	createTileColumnPattern(List<TileTypeEnum> types)
static TileColumnPattern	createTileColumnPattern(List<TileTypeEnum> filteredTypes, int start, int end) Creates a TileColumnPattern from an existing list of tile types and uses the start and end as indicies to get a sublist of filteredTypes.
static HashMap<TileColumnPattern,TreeSet<Integer>>	genColumnPatternMap(Device dev) Creates a map where the keys are all tile column patterns for the given device and the values are sets of occurrences/instances of those tile column patterns (represented by the the column index of the start of the pattern).
static HashMap<TileColumnPattern,TreeSet<Integer>>	genColumnPatternMap(Device dev, boolean wantLaguna) Creates a map where the keys are all tile column patterns for the given device and the values are sets of occurrences/instances of those tile column patterns (represented by the the column index of the start of the pattern).
static int	getCommonRow(Device dev) Finds the first row that has populated BRAM, DSP, URAM, and CLB tiles but no Laguna tiles to help identify tile column types.
static int	getCommonRow(Device dev, boolean wantLaguna) Finds the first row that has populated BRAM, DSP, URAM, and CLB tiles to help identify tile column types.
int	getNumInstances()
static TileColumnPattern[]	getSortedMostCommonPatterns(HashMap<TileColumnPattern,TreeSet<Integer>> map) Gets an array of all tile column pattersn sorted by those with the most number of instances.
static char	getTileCharacter(TileTypeEnum type, FamilyType arch) Helper function to help visualize tile column patterns by assigning an ASCII charcter to certain tile types.
String	getTilePatternString(FamilyType arch) Gets the short-hand ASCII tile column pattern.
boolean	hasBRAM()
boolean	hasDSP()
boolean	hasSLICEL()
boolean	hasSLICEM()
boolean	hasURAM()
static void	main(String[] args)
void	setNumInstances(int numInstances)

Methods inherited from class ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class AbstractList

equals, hashCode

Methods inherited from class AbstractCollection

containsAll, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface List

containsAll, equals, hashCode

Methods inherited from interface Collection

parallelStream, stream

Field Detail

MAX_PATTERN_LENGTH

public static int MAX_PATTERN_LENGTH

NULL_COLUMN_BREAK_SIZE

public static final int NULL_COLUMN_BREAK_SIZE

The number of consecutive NULL columns for a pattern not to cross

See Also:

Constant Field Values

Constructor Detail

TileColumnPattern

public TileColumnPattern()

Method Detail

createTileColumnPattern

public static TileColumnPattern createTileColumnPattern(List<TileTypeEnum> types)

createTileColumnPattern

public static TileColumnPattern createTileColumnPattern(List<TileTypeEnum> filteredTypes,
                                                        int start,
                                                        int end)

Creates a TileColumnPattern from an existing list of tile types and uses the start and end as indicies to get a sublist of filteredTypes.

Parameters:

filteredTypes - The list of tile types to turn into a pattern

start - The start index to use to build a subList of filteredTypes

end - The end index to use to build a subList of filteredTypes

Returns:

A tile column pattern or null if the list contained a NULL (break) tileType.

hasSLICEL

public boolean hasSLICEL()

hasSLICEM

public boolean hasSLICEM()

hasBRAM

public boolean hasBRAM()

hasDSP

public boolean hasDSP()

hasURAM

public boolean hasURAM()

getNumInstances

public int getNumInstances()

Returns:

the numInstances

setNumInstances

public void setNumInstances(int numInstances)

Parameters:

numInstances - the numInstances to set

getCommonRow

public static int getCommonRow(Device dev,
                               boolean wantLaguna)

Finds the first row that has populated BRAM, DSP, URAM, and CLB tiles to help identify tile column types. Can reliably iterate over this row and identify column types.

Parameters:

dev - The device of interest

wantLaguna - true if we are interested in a row with laguna tiles, false if interested in one without

Returns:

The row index that contains populated BRAM and DSP tiles.

getCommonRow

public static int getCommonRow(Device dev)

Finds the first row that has populated BRAM, DSP, URAM, and CLB tiles but no Laguna tiles to help identify tile column types. Can reliably iterate over this row and identify column types.

Parameters:

dev - The device of interest

Returns:

The row index that contains populated BRAM and DSP tiles.

genColumnPatternMap

public static HashMap<TileColumnPattern,TreeSet<Integer>> genColumnPatternMap(Device dev,
                                                                              boolean wantLaguna)

Creates a map where the keys are all tile column patterns for the given device and the values are sets of occurrences/instances of those tile column patterns (represented by the the column index of the start of the pattern).

Parameters:

dev - The device of interest

wantLaguna - true if we are interested in a row with laguna tiles, false if interested in one without

Returns:

The map between tile column patterns and their respective instances.

genColumnPatternMap

public static HashMap<TileColumnPattern,TreeSet<Integer>> genColumnPatternMap(Device dev)

Creates a map where the keys are all tile column patterns for the given device and the values are sets of occurrences/instances of those tile column patterns (represented by the the column index of the start of the pattern).

Parameters:

dev - The device of interest

Returns:

The map between tile column patterns and their respective instances.

getSortedMostCommonPatterns

public static TileColumnPattern[] getSortedMostCommonPatterns(HashMap<TileColumnPattern,TreeSet<Integer>> map)

Gets an array of all tile column pattersn sorted by those with the most number of instances.

Parameters:

map - A tile column pattern map such as one generated in genColumnPatternMap().

Returns:

An array of tile column patterns sorted by the patterns with the most number of instances.

getTileCharacter

public static char getTileCharacter(TileTypeEnum type,
                                    FamilyType arch)

Helper function to help visualize tile column patterns by assigning an ASCII charcter to certain tile types.

Parameters:

type - The tile type of interest.

arch - The device family

Returns:

A character to represent the tile type or '0' if not of interest.

getTilePatternString

public String getTilePatternString(FamilyType arch)

Gets the short-hand ASCII tile column pattern.

Parameters:

arch - Family of the device of interest.

Returns:

A string of the short-hand ASCII tile column type representation.

main

public static void main(String[] args)

compareTo

public int compareTo(TileColumnPattern o)

Specified by:

compareTo in interface Comparable<TileColumnPattern>