org.bytedeco.pytorch.StringSharedModuleDict Maven / Gradle / Ivy

Go to download
// Targeted by JavaCPP version 1.5.9: DO NOT EDIT THIS FILE

package org.bytedeco.pytorch;

import org.bytedeco.pytorch.Allocator;
import org.bytedeco.pytorch.Function;
import org.bytedeco.pytorch.Module;
import java.nio.*;
import org.bytedeco.javacpp.*;
import org.bytedeco.javacpp.annotation.*;

import static org.bytedeco.javacpp.presets.javacpp.*;
import static org.bytedeco.openblas.global.openblas_nolapack.*;
import static org.bytedeco.openblas.global.openblas.*;

import static org.bytedeco.pytorch.global.torch.*;

@Name("torch::OrderedDict >") @NoOffset @Properties(inherit = org.bytedeco.pytorch.presets.torch.class)
public class StringSharedModuleDict extends Pointer {
    static { Loader.load(); }
    /** Pointer cast constructor. Invokes {@link Pointer#Pointer(Pointer)}. */
    public StringSharedModuleDict(Pointer p) { super(p); }
    /** Native array allocator. Access with {@link Pointer#position(long)}. */
    public StringSharedModuleDict(long size) { super((Pointer)null); allocateArray(size); }
    private native void allocateArray(long size);
    @Override public StringSharedModuleDict position(long position) {
        return (StringSharedModuleDict)super.position(position);
    }
    @Override public StringSharedModuleDict getPointer(long i) {
        return new StringSharedModuleDict((Pointer)this).offsetAddress(i);
    }

  /** A (key, value) pair. */

  // The lifetime of an iterator is bound to the lifetime of the `OrderedDict`.
  // Further, any `insert()` operation may invalidate all iterators
  // pointing into the vector.

  /** Constructs the {@code OrderedDict} with a short description of the kinds of keys
   *  stored in the {@code OrderedDict}. This description is used in error messages
   *  thrown by the {@code OrderedDict}. */
  public StringSharedModuleDict(@StdString BytePointer key_description/*="Key"*/) { super((Pointer)null); allocate(key_description); }
  private native void allocate(@StdString BytePointer key_description/*="Key"*/);
  public StringSharedModuleDict() { super((Pointer)null); allocate(); }
  private native void allocate();
  public StringSharedModuleDict(@StdString String key_description/*="Key"*/) { super((Pointer)null); allocate(key_description); }
  private native void allocate(@StdString String key_description/*="Key"*/);

  /** Copy constructs this {@code OrderedDict} from {@code other}. */
  public StringSharedModuleDict(@Const @ByRef StringSharedModuleDict other) { super((Pointer)null); allocate(other); }
  private native void allocate(@Const @ByRef StringSharedModuleDict other);

  /** Assigns items from {@code other} to this {@code OrderedDict}. */
  public native @ByRef @Name("operator =") StringSharedModuleDict put(@Const @ByRef StringSharedModuleDict other);

  // NB: Move works by default, because you can move-construct vectors of const
  // values. I tried to make this noexcept (conditional on the move constructors
  // of index_ and items_ being noexcept) but the obvious spelling didn't
  // compile on Windows.

  /** Constructs a new {@code OrderedDict} and pre-populates it with the given
   *  {@code Item}s. */
  /*implicit */

  /** Returns the key description string the {@code OrderedDict} was constructed with. */
  public native @StdString @NoException(true) BytePointer key_description();

  // Element Access

  /** Returns the very first item in the {@code OrderedDict} and throws an exception
   *  if it is empty. */
  public native @ByRef StringSharedModuleDictItem front();

  /** Returns the very first item in the {@code OrderedDict} and throws an exception
   *  if it is empty. */

  /** Returns the very last item in the {@code OrderedDict} and throws an exception
   *  if it is empty. */
  public native @ByRef StringSharedModuleDictItem back();

  /** Returns the very last item in the {@code OrderedDict} and throws an exception
   *  if it is empty. */

  /** Returns the item at the {@code index}-th position in the {@code OrderedDict}. Throws
   *  an exception if the index is out of bounds. */
  public native @ByRef @Name("operator []") StringSharedModuleDictItem get(@Cast("size_t") long index);

  /** Returns the item at the {@code index}-th position in the {@code OrderedDict}. Throws
   *  an exception if the index is out of bounds. */

  /** Returns the value associated with the given {@code key}. Throws an exception if
   *  no such key is stored in the {@code OrderedDict}. Use {@code find()} for a
   *  non-throwing way of accessing a value if it is present. */
  public native @SharedPtr @ByRef @Name("operator []") Module get(@StdString BytePointer key);
  public native @SharedPtr @ByRef @Name("operator []") Module get(@StdString String key);

  /** Returns the value associated with the given {@code key}. Throws an exception if
   *  no such key is stored in the {@code OrderedDict}. Use {@code find()} for a
   *  non-throwing way of accessing a value if it is present. */

  // Lookup

  /** Returns a pointer to the value associated with the given key, or a
   *  {@code nullptr} if no such key is stored in the {@code OrderedDict}. */
  public native @SharedPtr @NoException(true) Module find(@StdString BytePointer key);
  public native @SharedPtr @NoException(true) Module find(@StdString String key);

  /** Returns a pointer to the value associated with the given key, or a
   *  {@code nullptr} if no such key is stored in the {@code OrderedDict}. */

  /** Returns true if the key is present in the {@code OrderedDict}. */
  public native @Cast("bool") @NoException(true) boolean contains(@StdString BytePointer key);
  public native @Cast("bool") @NoException(true) boolean contains(@StdString String key);

  // Iterators

  /** Returns an iterator to the first item in the {@code OrderedDict}. Iteration is
   *  ordered. */
  public native @ByVal @Cast("torch::OrderedDict >::Iterator*") StringSharedModuleDictItem begin();

  /** Returns an iterator to the first item in the {@code OrderedDict}. Iteration is
   *  ordered. */

  /** Returns an iterator one past the last item in the {@code OrderedDict}. */
  public native @ByVal @Cast("torch::OrderedDict >::Iterator*") StringSharedModuleDictItem end();

  /** Returns an iterator one past the last item in the {@code OrderedDict}. */

  // Capacity

  /** Returns the number of items currently stored in the {@code OrderedDict}. */
  public native @Cast("size_t") @NoException(true) long size();

  /** Returns true if the {@code OrderedDict} contains no elements. */
  public native @Cast("bool") @NoException(true) boolean is_empty();

  /** Resizes internal storage to fit at least {@code requested_capacity} items
   *  without requiring reallocation. */
  public native void reserve(@Cast("size_t") long requested_capacity);

  // Modifiers

  /** Inserts a new {@code (key, value)} pair into the {@code OrderedDict}. Throws an
   *  exception if the key is already present. If insertion is successful,
   *  immediately returns a reference to the inserted value. */

  /** Inserts a new {@code (key, value)} pair into the {@code OrderedDict}. Throws an
   *  exception if the key is already present. If insertion is successful,
   *  immediately returns a reference to the inserted value. */
  public native @SharedPtr @ByRef Module insert(@StdString BytePointer key, @SharedPtr @Cast({"", "std::shared_ptr"}) Module value);
  public native @SharedPtr @ByRef Module insert(@StdString String key, @SharedPtr @Cast({"", "std::shared_ptr"}) Module value);

  /** Inserts all items from {@code other} into this {@code OrderedDict}. If any key from
   *  {@code other} is already present in this {@code OrderedDict}, an exception is thrown. */
  public native void update(@ByRef(true) StringSharedModuleDict other);

  /** Inserts all items from {@code other} into this {@code OrderedDict}. If any key from
   *  {@code other} is already present in this {@code OrderedDict}, an exception is thrown. */

  /** Removes the item that has {@code key} from this {@code OrderedDict} if exists and if
   *  it doesn't an exception is thrown. */
  public native void erase(@StdString BytePointer key);
  public native void erase(@StdString String key);

  /** Removes all items from this {@code OrderedDict}. */
  public native void clear();

  // Observers

  /** Returns the items stored in the {@code OrderedDict}. */
  public native @StdVector @NoException(true) StringSharedModuleDictItem items();

  /** Returns a newly allocated vector and copies all keys from this
   *  {@code OrderedDict} into the vector. */
  public native @ByVal StringVector keys();

  /** Returns a newly allocated vector and copies all values from this
   *  {@code OrderedDict} into the vector. */
  public native @ByVal SharedModuleVector values();

  /** Returns a newly allocated vector and copies all keys and values from this
   *  {@code OrderedDict} into a vector of {@code std::pair}. */
  public native @ByVal StringSharedModulePairVector pairs();

  /** Returns true if both dicts contain the same keys and values, in the same
   *  order. */
  
  /** A mapping from a key to an index into the {@code items_} vector. */
}