Package org.robwork.sdurw_math

Class MetricQCPtr

  • public class MetricQCPtr
extends java.lang.Object
    Ptr stores a pointer and optionally takes ownership of the value.

    • Constructor Summary

      Constructors 
      Constructor Description
      MetricQCPtr()
      Default constructor yielding a NULL-pointer.
      MetricQCPtr​(long cPtr, boolean cMemoryOwn)  
      MetricQCPtr​(MetricQ ptr)
      Do not take ownership of ptr.

      ptr can be null.

      The constructor is implicit on purpose.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      MetricQ __ref__()
      Dereferencing operator.
      void delete()  
      MetricQ deref()
      The pointer stored in the object.
      double distance​(Q q)
      The distance from the zero element to q
      double distance​(Q a, Q b)
      The distance from element a to b.
      boolean equals​(MetricQ p)  
      static long getCPtr​(MetricQCPtr obj)  
      MetricQ getDeref()
      Member access operator.
      boolean isNull()
      checks if the pointer is null
      boolean isShared()
      check if this Ptr has shared ownership or none
      ownership
      int size()
      The dimension of elements on which this metric operates.

      The returns -1 if the elements don't have a measure of dimension or
      if the metric works for elements of all dimensions.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MetricQCPtr

        public MetricQCPtr​(long cPtr,
                   boolean cMemoryOwn)

      • MetricQCPtr

        public MetricQCPtr()
        Default constructor yielding a NULL-pointer.

      • MetricQCPtr

        public MetricQCPtr​(MetricQ ptr)
        Do not take ownership of ptr.

        ptr can be null.

        The constructor is implicit on purpose.

    • Method Detail

      • getCPtr

        public static long getCPtr​(MetricQCPtr obj)

      • delete

        public void delete()

      • deref

        public MetricQ deref()
        The pointer stored in the object.

      • __ref__

        public MetricQ __ref__()
        Dereferencing operator.

      • getDeref

        public MetricQ getDeref()
        Member access operator.

      • equals

        public boolean equals​(MetricQ p)

      • isShared

        public boolean isShared()
        check if this Ptr has shared ownership or none
        ownership
        Returns:
        true if Ptr has shared ownership, false if it has no ownership.

      • isNull

        public boolean isNull()
        checks if the pointer is null
        Returns:
        Returns true if the pointer is null

      • distance

        public double distance​(Q q)
        The distance from the zero element to q

      • distance

        public double distance​(Q a,
                       Q b)
        The distance from element a to b.
        Parameters:
        a - [in] first element
        b - [in] second element
        Returns:
        the distance

      • size

        public int size()
        The dimension of elements on which this metric operates.

        The returns -1 if the elements don't have a measure of dimension or
        if the metric works for elements of all dimensions.