Index (SpiNNaker Utilities 7.3.1 API)

A B C D E F G H I K L M N O P R S T U V W
All Classes|All Packages

A

add(int) - Method in class uk.ac.manchester.spinnaker.utils.Counter: Add any amount to the counter.
AND - Static variable in class uk.ac.manchester.spinnaker.utils.CollectionUtils: The binary and operator (&) as a function.
any() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.TCPPort: Whether to allow the "any" port.
any() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.UDPPort: Whether to allow the "any" port.
apply(Optional<T>, Consumer<T>...) - Static method in class uk.ac.manchester.spinnaker.utils.OptionalUtils: How to apply a sequence of modification transforms to a value in an optional if there is a value there at all.
await() - Method in class uk.ac.manchester.spinnaker.utils.OneShotEvent: Wait for the event to fire.

B

batch(int, List<T>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Given a list of elements, split it into batches of elements of a given size.
ByteBufferUtils - Class in uk.ac.manchester.spinnaker.utils: Utility methods for ByteBuffers.

C

ceildiv(int, int) - Static method in class uk.ac.manchester.spinnaker.utils.MathUtils: Divide one integer by another with rounding up.
close() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressBar: Ends the Progress bar line and prints a duration line.
close() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressIterable: Closes all created Iterators and their ProgressBar(s).
close() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressIterator: Closes the underlying ProgressBar.
close() - Method in class uk.ac.manchester.spinnaker.utils.ReaderLineIterable
CollectionUtils - Class in uk.ac.manchester.spinnaker.utils: Utilities for working with collections.
collectToArray(IntFunction<T[]>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Create a collector that produces an array from a stream.
compute(K, BiFunction<? super K, ? super V, ? extends V>) - Method in class uk.ac.manchester.spinnaker.utils.DefaultMap
computeIfAbsent(K, Function<? super K, ? extends V>) - Method in class uk.ac.manchester.spinnaker.utils.DefaultMap
computeIfPresent(K, BiFunction<? super K, ? super V, ? extends V>) - Method in class uk.ac.manchester.spinnaker.utils.DefaultMap
copy(List<T>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Makes a read-only copy of a list.
copy(Map<K, V>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Makes a read-only copy of a map.
copy(Set<T>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Makes a read-only copy of a set.
Counter - Class in uk.ac.manchester.spinnaker.utils: Thin wrapper around an int for counting.
Counter() - Constructor for class uk.ac.manchester.spinnaker.utils.Counter: Create a counter starting at zero.
createValue(K) - Method in interface uk.ac.manchester.spinnaker.utils.DefaultMap.KeyAwareFactory: Create a new value for the default map.
curry(BiFunction<T, U, V>, T) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Binary function currier.

D

Daemon - Class in uk.ac.manchester.spinnaker.utils: A thread that is a daemon by default.
Daemon(Runnable) - Constructor for class uk.ac.manchester.spinnaker.utils.Daemon: Allocate a new daemon thread.
Daemon(Runnable, String) - Constructor for class uk.ac.manchester.spinnaker.utils.Daemon: Allocate a new daemon thread.
Daemon(ThreadGroup, Runnable) - Constructor for class uk.ac.manchester.spinnaker.utils.Daemon: Allocate a new daemon thread.
Daemon(ThreadGroup, Runnable, String) - Constructor for class uk.ac.manchester.spinnaker.utils.Daemon: Allocate a new daemon thread.
DefaultMap<K,V> - Class in uk.ac.manchester.spinnaker.utils: A map that will extend itself with new values (on get) when the key is otherwise absent from the map.
DefaultMap(Supplier<? extends V>) - Constructor for class uk.ac.manchester.spinnaker.utils.DefaultMap: Create a new map.
DefaultMap.KeyAwareFactory<K,V> - Interface in uk.ac.manchester.spinnaker.utils: An advanced factory that has access to the key when it is creating the value to associate with it.
DoubleMapIterable<V> - Class in uk.ac.manchester.spinnaker.utils: An Iterable for a Map or Collection of Maps.
DoubleMapIterable(Iterable<? extends Map<?, V>>) - Constructor for class uk.ac.manchester.spinnaker.utils.DoubleMapIterable: Create an Iterator give a Collection/Iterable of Maps .
DoubleMapIterable(Map<?, ? extends Map<?, V>>) - Constructor for class uk.ac.manchester.spinnaker.utils.DoubleMapIterable: Creates an Iterable given a Map of Maps.

E

emptyOK() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.IPAddress: Whether the empty string is allowed.
ephemeral() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.TCPPort: Whether to allow ephemeral ports.
ephemeral() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.UDPPort: Whether to allow ephemeral ports.

F

filter(Predicate<T>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Apply a filter to an iterable to get another iterable.
fire() - Method in class uk.ac.manchester.spinnaker.utils.OneShotEvent: Fire the event.
first() - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Get the first item in the iterable, if there is one.
first(int) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Get another iterable with the first n item in the iterable (or up to that if the source iterable has fewer items).
formatDuration(long) - Static method in class uk.ac.manchester.spinnaker.utils.UnitConstants: Formats a duration with hours, minutes seconds and milliseconds as required.

G

get() - Method in class uk.ac.manchester.spinnaker.utils.Counter: Retrieve the current value.
get(Object) - Method in class uk.ac.manchester.spinnaker.utils.DefaultMap: Gets a value from the dictionary, inserting a newly manufactured value if the key has no mapping.
get(String, String) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: Get a value from the config.
getBoolean(String, String) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: Get a value from the config.
getByAddress(byte[]) - Static method in class uk.ac.manchester.spinnaker.utils.InetFactory: Creates a IPv4 address from the bytes representing the raw address.
getByAddressQuietly(byte[]) - Static method in class uk.ac.manchester.spinnaker.utils.InetFactory: Creates a IPv4 address from the bytes representing the raw address.
getByName(String) - Static method in class uk.ac.manchester.spinnaker.utils.InetFactory: Creates a IPv4 address from a host name.
getByNameQuietly(String) - Static method in class uk.ac.manchester.spinnaker.utils.InetFactory: Creates a IPv4 address from a host name.
getInt(String, String) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: Get a value from the config.
getValue() - Method in class uk.ac.manchester.spinnaker.utils.ValueHolder: Get the value held.

H

hasNext() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressIterator: Returns true if the iteration has more elements.
hexbyte(byte) - Static method in class uk.ac.manchester.spinnaker.utils.MathUtils: Converts a byte to its hexadecimal representation.

I

ifElse(Optional<T>, Function<T, U>, Supplier<U>) - Static method in class uk.ac.manchester.spinnaker.utils.OptionalUtils: How to do one thing if an optional is present, and another if it is absent.
ifElseFlat(Optional<T>, Function<T, U>, Supplier<U>) - Static method in class uk.ac.manchester.spinnaker.utils.OptionalUtils: How to do one thing if an optional is present, and another if it is absent.
increment() - Method in class uk.ac.manchester.spinnaker.utils.Counter: Add one to the count.
Inet6NotSupportedException(String) - Constructor for exception uk.ac.manchester.spinnaker.utils.InetFactory.Inet6NotSupportedException: Constructs a new Inet6NotSupportedException with the specified detail message.
InetFactory - Class in uk.ac.manchester.spinnaker.utils: Convenience methods for creating IPv4 Addresses.
InetFactory.Inet6NotSupportedException - Exception in uk.ac.manchester.spinnaker.utils: Specific Exception to show IPv6 is not supported.
IPAddress - Annotation Type in uk.ac.manchester.spinnaker.utils.validation: Validates that a string looks like an IP address.
isClosed() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressBar
isNone(String) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: How to decide if a value is to be treated as null.
iterator() - Method in class uk.ac.manchester.spinnaker.utils.DoubleMapIterable
iterator() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressIterable: Starts a ProgressBar and returns an iterator over the elements of the iterable contained within this iterable.
iterator() - Method in class uk.ac.manchester.spinnaker.utils.ReaderLineIterable
iterator() - Method in class uk.ac.manchester.spinnaker.utils.TripleMapIterable

K

KILOBYTE - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of bytes in a kilobyte.

L

limitSlice(ByteBuffer, int) - Static method in class uk.ac.manchester.spinnaker.utils.ByteBufferUtils: Make a slice of a byte buffer if it exceeds a given size.
lmap(Collection<T>, Function<T, U>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Like Stream.map(Function), but for lists/collections.

M

makeEnumBackingMap(E[], Function<E, K>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Utility for making the backing maps for fast enums.
map(Function<T, U>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Apply a function to an iterable to get another iterable.
MappableIterable<T> - Interface in uk.ac.manchester.spinnaker.utils: Extends iterable with the ability to be mapped to different values.
MathUtils - Class in uk.ac.manchester.spinnaker.utils: Miscellaneous mathematical functions.
MAX_TCP_PORT - Static variable in annotation type uk.ac.manchester.spinnaker.utils.validation.TCPPort: The maximum TCP port number.
MAX_UDP_PORT - Static variable in annotation type uk.ac.manchester.spinnaker.utils.validation.UDPPort: The maximum UDP port number.
MEGABYTE - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of bytes in a megabyte.
MEGAHERTZ_PER_HERTZ - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of megahertz in each hertz.
MEGAHERTZ_PER_KILOHERTZ - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of megahertz in each kilohertz.
merge(K, V, BiFunction<? super V, ? super V, ? extends V>) - Method in class uk.ac.manchester.spinnaker.utils.DefaultMap
message() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.IPAddress: Message on constraint violated.
message() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.TCPPort: Message on constraint violated.
message() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.UDPPort: Message on constraint violated.
MIN_TCP_PORT - Static variable in annotation type uk.ac.manchester.spinnaker.utils.validation.TCPPort: The minimum ordinary TCP port number.
MIN_UDP_PORT - Static variable in annotation type uk.ac.manchester.spinnaker.utils.validation.UDPPort: The minimum ordinary UDP port number.
MINUTE_PER_HOUR - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of minute per hour.
MSEC_PER_SEC - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of milliseconds per second.

N

newAdvancedDefaultMap(DefaultMap.KeyAwareFactory<? super K, ? extends V>) - Static method in class uk.ac.manchester.spinnaker.utils.DefaultMap: Create a new map that manufactures new elements that are aware of their key from the beginning.
newMapWithDefault(DV) - Static method in class uk.ac.manchester.spinnaker.utils.DefaultMap: Create a new map.
next() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressIterator: Returns the next element in the iteration, and updates the ProgressBar.
normaliseOptionName(String) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: How to convert an option name into canonical form.
normaliseSectionName(String) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: How to convert a section name into canonical form.
NSEC_PER_MSEC - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of nanoseconds per millisecond.
NSEC_PER_SEC - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of nanoseconds per second.
NSEC_PER_USEC - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of nanoseconds per microsecond.
nth(int) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Index into the iterable.
nullOK() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.IPAddress: Whether null is allowed.

O

OneShotEvent - Class in uk.ac.manchester.spinnaker.utils: An asynchronous event that can be fired exactly once.
OneShotEvent() - Constructor for class uk.ac.manchester.spinnaker.utils.OneShotEvent
OptionalUtils - Class in uk.ac.manchester.spinnaker.utils: Extra utilities for working with Optional in Java 8.
OR - Static variable in class uk.ac.manchester.spinnaker.utils.CollectionUtils: The binary or operator (|) as a function.

P

parseCommaSeparatedSet(String, Function<String, T>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Parse a comma-separated string into an unordered set of items.
ping(String) - Static method in class uk.ac.manchester.spinnaker.utils.Ping: Pings to detect if a host or IP address is reachable.
ping(InetAddress) - Static method in class uk.ac.manchester.spinnaker.utils.Ping: Pings to detect if a host or IP address is reachable.
Ping - Class in uk.ac.manchester.spinnaker.utils: How to ping a host to test for (ICMP) network connectivity.
ProgressBar - Class in uk.ac.manchester.spinnaker.utils.progress: Progress bar for telling the user where a task is up to and for reporting the duration.
ProgressBar(int, String) - Constructor for class uk.ac.manchester.spinnaker.utils.progress.ProgressBar: Creates a Progress bar which outputs to System.out.
ProgressBar(int, String, PrintStream) - Constructor for class uk.ac.manchester.spinnaker.utils.progress.ProgressBar: Creates a progress bar which outputs to the given PrintStream.
ProgressIterable<E> - Class in uk.ac.manchester.spinnaker.utils.progress: An Iterable wrapper that will start a ProgressBar for each iterator.
ProgressIterable(Collection<E>, String) - Constructor for class uk.ac.manchester.spinnaker.utils.progress.ProgressIterable: Creates an iterable wrapper but not yet a ProgressBar.
ProgressIterable(Collection<E>, String, PrintStream) - Constructor for class uk.ac.manchester.spinnaker.utils.progress.ProgressIterable: Creates an iterable wrapper but not yet a ProgressBar.
ProgressIterator<E> - Class in uk.ac.manchester.spinnaker.utils.progress: An Iterator wrapper with and an attached ProgressBar.
ProgressIterator(Collection<E>, String, PrintStream) - Constructor for class uk.ac.manchester.spinnaker.utils.progress.ProgressIterator: Creates a new ProgressIterable and a bar on the output stream.

R

range(int) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Generate an iterable that covers a range starting at zero and counting up.
range(int, int) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Generate an iterable that covers a range.
RawConfigParser - Class in uk.ac.manchester.spinnaker.utils: A cut-down limited version of the parser used in Python.
RawConfigParser() - Constructor for class uk.ac.manchester.spinnaker.utils.RawConfigParser: Create a configuration with no values defined in it.
RawConfigParser(File) - Constructor for class uk.ac.manchester.spinnaker.utils.RawConfigParser: Create a configuration from the given configuration file.
RawConfigParser(String, String) - Constructor for class uk.ac.manchester.spinnaker.utils.RawConfigParser: Create a basic configuration parser.
RawConfigParser(URL) - Constructor for class uk.ac.manchester.spinnaker.utils.RawConfigParser: Create a configuration from the given configuration file.
read(File) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: Read a configuration file.
read(InputStream, ByteBuffer, int) - Static method in class uk.ac.manchester.spinnaker.utils.ByteBufferUtils: Read a chunk of an input stream into a byte buffer.
read(URL) - Method in class uk.ac.manchester.spinnaker.utils.RawConfigParser: Read a configuration file.
ReaderLineIterable - Class in uk.ac.manchester.spinnaker.utils: A simple one-shot iterable wrapper for a reader.
ReaderLineIterable(InputStream) - Constructor for class uk.ac.manchester.spinnaker.utils.ReaderLineIterable: Create a new one-shot iterable.
ReaderLineIterable(Reader) - Constructor for class uk.ac.manchester.spinnaker.utils.ReaderLineIterable: Create a new one-shot iterable.

S

SEC_PER_MINUTE - Static variable in class uk.ac.manchester.spinnaker.utils.UnitConstants: The number of second per minute.
setValue(T) - Method in class uk.ac.manchester.spinnaker.utils.ValueHolder: Set the value to hold.
sleep(long) - Static method in class uk.ac.manchester.spinnaker.utils.ThreadUtils: Recommended way of doing "quiet" sleeps.
slice(ByteBuffer, int, int) - Static method in class uk.ac.manchester.spinnaker.utils.ByteBufferUtils: Make a slice of a byte buffer without modifying the original buffer.
sliceUp(ByteBuffer, int) - Static method in class uk.ac.manchester.spinnaker.utils.ByteBufferUtils: Slice up a buffer buffer into a sequence of (little-endian) byte buffers with a maximum size.
system() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.TCPPort: Whether to allow system ports.
system() - Method in annotation type uk.ac.manchester.spinnaker.utils.validation.UDPPort: Whether to allow system ports.

T

TCPPort - Annotation Type in uk.ac.manchester.spinnaker.utils.validation: Validates that a number looks like a TCP port.
threadDump() - Static method in class uk.ac.manchester.spinnaker.utils.ThreadUtils: Produce a dump of what all threads are doing.
ThreadUtils - Class in uk.ac.manchester.spinnaker.utils: Utilities for working with threads.
toCollectingMap(Class<E>, Function<T, K>, Function<T, E>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a map of sets of enum values.
toCollectingMap(Function<T, K>, Function<T, V>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a map of lists.
toCollectingMap(Supplier<Map<K, S>>, Supplier<S>, Function<T, K>, Function<T, V>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a map of collections.
toCollectingMap(Supplier<S>, Function<T, K>, Function<T, V>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a map of collections.
toEnumSet(Class<E>) - Static method in class uk.ac.manchester.spinnaker.utils.CollectionUtils: Create a collector that collects to an EnumSet.
toList() - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a list.
toList(Supplier<List<T>>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a list.
toMap(Function<T, K>, Function<T, V>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a map.
toMap(Supplier<Map<K, V>>, Function<T, K>, Function<T, V>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a map.
toSet() - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a set.
toSet(Supplier<Set<T>>) - Method in interface uk.ac.manchester.spinnaker.utils.MappableIterable: Convert this iterable to a set.
TripleMapIterable<V> - Class in uk.ac.manchester.spinnaker.utils: An Iterator for a Map or Collection of Maps of maps.
TripleMapIterable(Iterable<? extends Map<?, ? extends Map<?, V>>>) - Constructor for class uk.ac.manchester.spinnaker.utils.TripleMapIterable: Creates an Iterable given a Iterable/Collection of Maps of Maps.
TripleMapIterable(Map<?, ? extends Map<?, ? extends Map<?, V>>>) - Constructor for class uk.ac.manchester.spinnaker.utils.TripleMapIterable: Creates an Iterable given a Map of Maps of Maps.

U

UDPPort - Annotation Type in uk.ac.manchester.spinnaker.utils.validation: Validates that a number looks like a UDP port.
uk.ac.manchester.spinnaker.utils - package uk.ac.manchester.spinnaker.utils: General utilities for the SpiNNaker runtime.
uk.ac.manchester.spinnaker.utils.progress - package uk.ac.manchester.spinnaker.utils.progress: ProegressBar (and Timer) utilities.
uk.ac.manchester.spinnaker.utils.validation - package uk.ac.manchester.spinnaker.utils.validation: Utilities for validation of things.
UnitConstants - Class in uk.ac.manchester.spinnaker.utils: Constants relating to physical units.
update() - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressBar: Update the progress bar by a one unit.
update(int) - Method in class uk.ac.manchester.spinnaker.utils.progress.ProgressBar: Update the progress bar by a given amount.
update(Function<T, T>) - Method in class uk.ac.manchester.spinnaker.utils.ValueHolder: Applies a function to update the value of this instance, returning the old value.
UsedInJavadocOnly - Annotation Type in uk.ac.manchester.spinnaker.utils: Marks that the given class is used for Javadoc generation only, but needs to be referenced for Checkstyle.

V

value() - Method in annotation type uk.ac.manchester.spinnaker.utils.UsedInJavadocOnly: Class or classes just used by the annotated thing in Javadoc generation.
ValueHolder<T> - Class in uk.ac.manchester.spinnaker.utils: A simple class that can optionally hold a single value.
ValueHolder() - Constructor for class uk.ac.manchester.spinnaker.utils.ValueHolder: Create an instance.
ValueHolder(T) - Constructor for class uk.ac.manchester.spinnaker.utils.ValueHolder: Create an instance.

W

waitfor(Object) - Static method in class uk.ac.manchester.spinnaker.utils.ThreadUtils: Wait for the given object.
waitfor(Object, long) - Static method in class uk.ac.manchester.spinnaker.utils.ThreadUtils: Wait for the given object.
waitUntil(long) - Static method in class uk.ac.manchester.spinnaker.utils.WaitUtils: Wait until the given time has passed.
WaitUtils - Class in uk.ac.manchester.spinnaker.utils: Utilities for waiting very short periods of time.

A B C D E F G H I K L M N O P R S T U V W
All Classes|All Packages