org.nd4j.base

Class Preconditions

java.lang.Object

org.nd4j.base.Preconditions

public class Preconditions
extends Object

Utility method for method checking arguments.

Author:

Alex Black

Method Summary

Modifier and Type	Method and Description
static void	checkArgument(boolean b) Check the specified boolean argument.
static void	checkArgument(boolean b, String message) Check the specified boolean argument.
static void	checkArgument(boolean b, String msg, double arg1) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, double arg1, double arg2) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, double arg1, double arg2, double arg3) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, double arg1, double arg2, double arg3, double arg4) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, int arg1) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, int arg1, int arg2) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, int arg1, int arg2, int arg3) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, int arg1, int arg2, int arg3, int arg4) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, long arg1) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, long arg1, long arg2) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, long arg1, long arg2, long arg3) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, long arg1, long arg2, long arg3, long arg4) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String message, Object... args) Check the specified boolean argument.
static void	checkArgument(boolean b, String msg, Object arg1) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, Object arg1, Object arg2) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5) See checkArgument(boolean, String, Object...)
static void	checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6) See checkArgument(boolean, String, Object...)
static void	checkNotNull(Object o) Check the specified boolean argument.
static void	checkNotNull(Object o, String message) Check the specified boolean argument.
static void	checkNotNull(Object o, String msg, double arg1) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, double arg1, double arg2) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, double arg1, double arg2, double arg3) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, double arg1, double arg2, double arg3, double arg4) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, int arg1) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, int arg1, int arg2) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, int arg1, int arg2, int arg3) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, int arg1, int arg2, int arg3, int arg4) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, long arg1) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, long arg1, long arg2) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, long arg1, long arg2, long arg3) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, long arg1, long arg2, long arg3, long arg4) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String message, Object... args) Check the specified boolean argument.
static void	checkNotNull(Object o, String msg, Object arg1) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, Object arg1, Object arg2) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, Object arg1, Object arg2, Object arg3) See checkNotNull(Object, String, Object...)
static void	checkNotNull(Object o, String msg, Object arg1, Object arg2, Object arg3, Object arg4) See checkNotNull(Object, String, Object...)
static void	checkState(boolean b) Check the specified boolean argument.
static void	checkState(boolean b, String message) Check the specified boolean argument.
static void	checkState(boolean b, String msg, double arg1) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, double arg1, double arg2) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, double arg1, double arg2, double arg3) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, double arg1, double arg2, double arg3, double arg4) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, int arg1) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, int arg1, int arg2) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, int arg1, int arg2, int arg3) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, int arg1, int arg2, int arg3, int arg4) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, long arg1) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, long arg1, long arg2) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, long arg1, long arg2, long arg3) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, long arg1, long arg2, long arg3, long arg4) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String message, Object... args) Check the specified boolean argument.
static void	checkState(boolean b, String msg, Object arg1) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, Object arg1, Object arg2) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5) See checkState(boolean, String, Object...)
static void	checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6) See checkState(boolean, String, Object...)
static void	throwEx(String message, Object... args)
static void	throwNullPointerEx(String message, Object... args)
static void	throwStateEx(String message, Object... args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

checkArgument

public static void checkArgument(boolean b)

Check the specified boolean argument. Throws an IllegalArgumentException if b is false

Parameters:

b - Argument to check

checkArgument

public static void checkArgument(boolean b,
                                 String message)

Check the specified boolean argument. Throws an IllegalArgumentException with the specified message if b is false

Parameters:

b - Argument to check

message - Message for exception. May be null

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 int arg1)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 long arg1)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 double arg1)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 Object arg1)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 int arg1,
                                 int arg2)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 long arg1,
                                 long arg2)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 double arg1,
                                 double arg2)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 Object arg1,
                                 Object arg2)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 int arg1,
                                 int arg2,
                                 int arg3)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 long arg1,
                                 long arg2,
                                 long arg3)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 double arg1,
                                 double arg2,
                                 double arg3)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 Object arg1,
                                 Object arg2,
                                 Object arg3)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 int arg1,
                                 int arg2,
                                 int arg3,
                                 int arg4)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 long arg1,
                                 long arg2,
                                 long arg3,
                                 long arg4)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 double arg1,
                                 double arg2,
                                 double arg3,
                                 double arg4)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 Object arg1,
                                 Object arg2,
                                 Object arg3,
                                 Object arg4)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 Object arg1,
                                 Object arg2,
                                 Object arg3,
                                 Object arg4,
                                 Object arg5)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String msg,
                                 Object arg1,
                                 Object arg2,
                                 Object arg3,
                                 Object arg4,
                                 Object arg5,
                                 Object arg6)

See checkArgument(boolean, String, Object...)

checkArgument

public static void checkArgument(boolean b,
                                 String message,
                                 Object... args)

Check the specified boolean argument. Throws an IllegalArgumentException with the specified message if b is false. Note that the message may specify argument locations using "%s" - for example, checkArgument(false, "Got %s values, expected %s", 3, "more" would throw an IllegalArgumentException with the message "Got 3 values, expected more"

Parameters:

b - Argument to check

message - Message for exception. May be null.

args - Arguments to place in message

checkState

public static void checkState(boolean b)

Check the specified boolean argument. Throws an IllegalStateException if b is false

Parameters:

b - State to check

checkState

public static void checkState(boolean b,
                              String message)

Check the specified boolean argument. Throws an IllegalStateException with the specified message if b is false

Parameters:

b - State to check

message - Message for exception. May be null

checkState

public static void checkState(boolean b,
                              String msg,
                              int arg1)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              long arg1)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              double arg1)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              Object arg1)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              int arg1,
                              int arg2)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              long arg1,
                              long arg2)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              double arg1,
                              double arg2)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              Object arg1,
                              Object arg2)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              int arg1,
                              int arg2,
                              int arg3)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              long arg1,
                              long arg2,
                              long arg3)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              double arg1,
                              double arg2,
                              double arg3)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              Object arg1,
                              Object arg2,
                              Object arg3)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              int arg1,
                              int arg2,
                              int arg3,
                              int arg4)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              long arg1,
                              long arg2,
                              long arg3,
                              long arg4)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              double arg1,
                              double arg2,
                              double arg3,
                              double arg4)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              Object arg1,
                              Object arg2,
                              Object arg3,
                              Object arg4)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              Object arg1,
                              Object arg2,
                              Object arg3,
                              Object arg4,
                              Object arg5)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String msg,
                              Object arg1,
                              Object arg2,
                              Object arg3,
                              Object arg4,
                              Object arg5,
                              Object arg6)

See checkState(boolean, String, Object...)

checkState

public static void checkState(boolean b,
                              String message,
                              Object... args)

Check the specified boolean argument. Throws an IllegalStateException with the specified message if b is false. Note that the message may specify argument locations using "%s" - for example, checkArgument(false, "Got %s values, expected %s", 3, "more" would throw an IllegalStateException with the message "Got 3 values, expected more"

Parameters:

b - Argument to check

message - Message for exception. May be null.

args - Arguments to place in message

checkNotNull

public static void checkNotNull(Object o)

Check the specified boolean argument. Throws an NullPointerException if o is false

Parameters:

o - Object to check

checkNotNull

public static void checkNotNull(Object o,
                                String message)

Check the specified boolean argument. Throws an NullPointerException with the specified message if o is false

Parameters:

o - Object to check

message - Message for exception. May be null

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                int arg1)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                long arg1)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                double arg1)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                Object arg1)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                int arg1,
                                int arg2)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                long arg1,
                                long arg2)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                double arg1,
                                double arg2)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                Object arg1,
                                Object arg2)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                int arg1,
                                int arg2,
                                int arg3)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                long arg1,
                                long arg2,
                                long arg3)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                double arg1,
                                double arg2,
                                double arg3)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                Object arg1,
                                Object arg2,
                                Object arg3)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                int arg1,
                                int arg2,
                                int arg3,
                                int arg4)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                long arg1,
                                long arg2,
                                long arg3,
                                long arg4)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                double arg1,
                                double arg2,
                                double arg3,
                                double arg4)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String msg,
                                Object arg1,
                                Object arg2,
                                Object arg3,
                                Object arg4)

See checkNotNull(Object, String, Object...)

checkNotNull

public static void checkNotNull(Object o,
                                String message,
                                Object... args)

Check the specified boolean argument. Throws an IllegalStateException with the specified message if o is false. Note that the message may specify argument locations using "%s" - for example, checkArgument(false, "Got %s values, expected %s", 3, "more" would throw an IllegalStateException with the message "Got 3 values, expected more"

Parameters:

o - Object to check

message - Message for exception. May be null.

args - Arguments to place in message

throwEx

public static void throwEx(String message,
                           Object... args)

throwStateEx

public static void throwStateEx(String message,
                                Object... args)

throwNullPointerEx

public static void throwNullPointerEx(String message,
                                      Object... args)