jcuda.driver.JITOptions Maven / Gradle / Ivy
The newest version!
/*
* JCuda - Java bindings for NVIDIA CUDA driver and runtime API
*
* Copyright (c) 2009-2012 Marco Hutter - http://www.jcuda.org
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
package jcuda.driver;
import java.util.*;
/**
* Note: This class should be considered as preliminary,
* and might change in future releases.
*
* A utility class to circumvent the limitations of Java in terms
* of interpreting memory areas as pointers or primitive values:
*
*
* This class allows mapping {@link CUjit_option} identifiers to
* their respective values, so that the options may be passed
* to methods that require the parameters
* unsigned int numOptions, CUjit_option *options,
* void **optionValues
* in the original CUDA API:
*/
public final class JITOptions
{
/**
* The map storing the options and their values
*/
private final Map map =
new LinkedHashMap();
/**
* Creates new, empty JITOptions
*/
public JITOptions()
{
}
/**
* Package private method to obtain the keys stored in these
* options. Also used on native side.
*
* @return The keys of these options
*/
int[] getKeys()
{
Set keySet = map.keySet();
int keys[] = new int[keySet.size()];
int index = 0;
for (Integer key : keySet)
{
keys[index] = key;
index++;
}
return keys;
}
/**
* Removes the specified option
*
* @param key An option identifier
*/
public void remove(int key)
{
map.remove(key);
}
/**
* Put the specified option into these options (without a value)
*
* @param key An option identifier
*/
public void put(int key)
{
map.put(key, null);
}
/**
* Put the given value for the specified option into these options
*
* @param key An option identifier
* @param value The option value
*/
public void putInt(int key, int value)
{
map.put(key, value);
}
/**
* Put the given value for the specified option into these options
*
* @param key An option identifier
* @param value The option value
*/
public void putFloat(int key, float value)
{
map.put(key, value);
}
/**
* Put the given value for the specified option into these options
*
* @param key An option identifier
* @param value The option value
*/
public void putBytes(int key, byte value[])
{
map.put(key, value);
}
/**
* Returns the value of the given option. Returns 0 if the specified
* option is unknown or not an int or
* unsigned int value.
*
* @param key An option identifier
* @return The option value
*/
public int getInt(int key)
{
Object value = map.get(key);
if (!(value instanceof Integer))
{
return 0;
}
Integer result = (Integer)value;
return result;
}
/**
* Returns the value of the given option. Returns 0 if the specified
* option is unknown or not a float value.
*
* @param key An option identifier
* @return The option value
*/
public float getFloat(int key)
{
Object value = map.get(key);
if (!(value instanceof Float))
{
return 0.0f;
}
Float result = (Float)value;
return result;
}
/**
* Returns the value of the given option. Returns null if
* the specified option is unknown or not a byte[] value.
*
* @param key An option identifier
* @return The option value
*/
public byte[] getBytes(int key)
{
Object value = map.get(key);
if (value == null)
{
return null;
}
if (!(value instanceof byte[]))
{
return null;
}
byte data[] = (byte[])value;
return data;
}
/**
* Convenience method that returns the value of the given option
* as a string. The byte array for the specified option will be
* obtained and converted into a string. Returns null if
* the specified option is unknown or not a byte[] value.
*
* @param key An option identifier
* @return The option value
*/
public String getString(int key)
{
byte data[] = getBytes(key);
if (data == null)
{
return null;
}
return createString(data);
}
/**
* Converts the given byte array into a String. The characters
* of the given data are connected to a String, until a
* terminating '\0' character is encountered.
*
* @param data The byte array
* @return The String
*/
private static String createString(byte data[])
{
StringBuilder sb = new StringBuilder();
for (int i=0; i