polyrun.sampling.OutOfBoundsBehaviour Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of polyrun Show documentation

A library containing implementation of uniform sampling from bounded convex polytopes.

There is a newer version: 1.1.0

// Copyright (c) 2015-2018 Krzysztof Ciomek
//
// 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 polyrun.sampling;

/**
 * Describes the behaviour of random walk when it tries to make a step that exceeds bounds of the polytope.
 * It applies only to some random walks.
 * 
 * Stay - does not make a step, i.e., next sample will be the same as previous one (the default behaviour)
 * Crop - crops the step to the bound (useful for sampling neighborhood)
 * Reflect - reflects from the bound (or stays if reflection also exceeds bounds)
 */
public enum OutOfBoundsBehaviour {
    Stay,
    Crop
}