Package org.robwork.sdurw
Class QSamplerPtr
- java.lang.Object
- 
- org.robwork.sdurw.QSamplerPtr
 
- 
 public class QSamplerPtr extends java.lang.ObjectPtr stores a pointer and optionally takes ownership of the value.
- 
- 
Constructor SummaryConstructors Constructor Description QSamplerPtr()Default constructor yielding a NULL-pointer.QSamplerPtr(long cPtr, boolean cMemoryOwn)QSamplerPtr(QSampler ptr)Do not take ownership of ptr.
 
 ptr can be null.
 
 The constructor is implicit on purpose.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description QSampler__ref__()Dereferencing operator.QSamplerCPtrcptr()voiddelete()QSamplerderef()The pointer stored in the object.booleanempty()True if the sampler is known to contain no more
 configurations.booleanequals(QSampler p)static longgetCPtr(QSamplerPtr obj)QSamplergetDeref()Member access operator.booleanisNull()checks if the pointer is nullbooleanisShared()check if this Ptr has shared ownership or none
 ownershipQSamplerPtrmakeConstrained(QSamplerPtr sampler, QConstraintCPtr constraint)Map a sampler of standard configurations into a sampler of
 normalized configurations.
 
 A sampler of IK solutions for a specific target.
 QSamplerPtrmakeConstrained(QSamplerPtr sampler, QConstraintCPtr constraint, int maxAttempts)Map a sampler of standard configurations into a sampler of
 normalized configurations.
 
 A sampler of IK solutions for a specific target.
 QSamplerPtrmakeEmpty()Empty sampler.QSamplerPtrmakeFinite(QSamplerPtr sampler, int cnt)A sampler to that returns only the first cnt samples from
 another sampler.
 
 The sampler is considered empty as soon as sampler is empty or the
 sampler has been called cnt times or more.QSamplerPtrmakeFinite(VectorQ qs)Sampler for the values of a finite sequence.
 
 sample() returns each of the values of qs in order.QSamplerPtrmakeFixed(Q q)Sampler that always returns the same configuration.
 
 The sampler is considered never empty (empty() always returns false).QSamplerPtrmakeSingle(Q q)Sampler that always returns a single configuration.
 
 The sample() returns q the first time the method is called and the
 empty configuration otherwise.QSamplerPtrmakeUniform(Device device)Uniform random sampling for a box of the configuration space.
 
 Uniform random sampling for a device.QSamplerPtrmakeUniform(DeviceCPtr device)Uniform random sampling for a device.Qsample()Sample a configuration.
 
 If sampling fails, the sampler may return the empty configuration.
 
- 
- 
- 
Constructor Detail- 
QSamplerPtrpublic QSamplerPtr(long cPtr, boolean cMemoryOwn)
 - 
QSamplerPtrpublic QSamplerPtr() Default constructor yielding a NULL-pointer.
 - 
QSamplerPtrpublic QSamplerPtr(QSampler ptr) Do not take ownership of ptr.
 
 ptr can be null.
 
 The constructor is implicit on purpose.
 
- 
 - 
Method Detail- 
getCPtrpublic static long getCPtr(QSamplerPtr obj) 
 - 
deletepublic void delete() 
 - 
derefpublic QSampler deref() The pointer stored in the object.
 - 
__ref__public QSampler __ref__() Dereferencing operator.
 - 
getDerefpublic QSampler getDeref() Member access operator.
 - 
equalspublic boolean equals(QSampler p) 
 - 
isSharedpublic 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.
 
 - 
isNullpublic boolean isNull() checks if the pointer is null- Returns:
- Returns true if the pointer is null
 
 - 
cptrpublic QSamplerCPtr cptr() 
 - 
samplepublic Q sample() Sample a configuration.
 
 If sampling fails, the sampler may return the empty configuration. If
 empty() is true then the sampler has no more configurations.
 Otherwise sample() may (or may not) succeed if called a second time.
 - 
emptypublic boolean empty() True if the sampler is known to contain no more
 configurations.
 - 
makeEmptypublic QSamplerPtr makeEmpty() Empty sampler.
 - 
makeFixedpublic QSamplerPtr makeFixed(Q q) Sampler that always returns the same configuration.
 
 The sampler is considered never empty (empty() always returns false).
 - 
makeSinglepublic QSamplerPtr makeSingle(Q q) Sampler that always returns a single configuration.
 
 The sample() returns q the first time the method is called and the
 empty configuration otherwise. empty() returns true after the first
 call of sample().
 - 
makeFinitepublic QSamplerPtr makeFinite(VectorQ qs) Sampler for the values of a finite sequence.
 
 sample() returns each of the values of qs in order. When all of
 these samples have been returned, empty() returns true and sample()
 returns the empty configuration.
 - 
makeFinitepublic QSamplerPtr makeFinite(QSamplerPtr sampler, int cnt) A sampler to that returns only the first cnt samples from
 another sampler.
 
 The sampler is considered empty as soon as sampler is empty or the
 sampler has been called cnt times or more.
 - 
makeUniformpublic QSamplerPtr makeUniform(Device device) Uniform random sampling for a box of the configuration space.
 
 Uniform random sampling for a device.
 - 
makeUniformpublic QSamplerPtr makeUniform(DeviceCPtr device) Uniform random sampling for a device.
 - 
makeConstrainedpublic QSamplerPtr makeConstrained(QSamplerPtr sampler, QConstraintCPtr constraint, int maxAttempts) Map a sampler of standard configurations into a sampler of
 normalized configurations.
 
 A sampler of IK solutions for a specific target.
 - Parameters:
- sampler- [in] Sampler of IK solutions for target.
 
 
 A sampler filtered by a constraint.
 
 For each call of sample() up to maxAttempts configurations are
 extracted from sampler and checked by constraint. The first
 sample that satisfies the constraint is returned; if no such were
 found the empty configuration is returned.
 
 If maxAttempts is negative (this is the default), then sampler
 is sampled forever until either the sampler is empty or a
 configuration satisfying constraint is found.
 
 - 
makeConstrainedpublic QSamplerPtr makeConstrained(QSamplerPtr sampler, QConstraintCPtr constraint) Map a sampler of standard configurations into a sampler of
 normalized configurations.
 
 A sampler of IK solutions for a specific target.
 - Parameters:
- sampler- [in] Sampler of IK solutions for target.
 
 
 A sampler filtered by a constraint.
 
 For each call of sample() up to maxAttempts configurations are
 extracted from sampler and checked by constraint. The first
 sample that satisfies the constraint is returned; if no such were
 found the empty configuration is returned.
 
 If maxAttempts is negative (this is the default), then sampler
 is sampled forever until either the sampler is empty or a
 configuration satisfying constraint is found.
 
 
- 
 
-