CspTerm Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Defines a variable or function to use in modeling.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Solvers.CspTerm

Namespace:  Microsoft.SolverFoundation.Solvers
Assembly:  Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)

Syntax

'Declaration
Public MustInherit Class CspTerm
public abstract class CspTerm
public ref class CspTerm abstract
[<AbstractClass>]
type CspTerm =  class end
public abstract class CspTerm

The CspTerm type exposes the following members.

Constructors

  Name Description
Protected method CspTerm Initializes a new instance of the CspTerm class.

Top

Properties

  Name Description
Public property CurrentValues Gets a collection of possible values in the domain of a term.
Public property Inputs Gets an array of input terms.
Public property IsBoolean Gets a value that indicates whether a term is associated with a Boolean domain.
Public property Key Gets or sets an identifier for variable or function terms.
Public property Kind Gets the value kind of a term.
Public property Model Gets the constraint system that a term belongs to.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method Field(Object) Returns the first element of a field that is labeled by a key.
Public method Field(Object, Int32) Returns an indexed element of a field that is labeled by a key.
Public method Fields Returns a collection of fields that are labeled by a key.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Operators

  Name Description
Public operatorStatic member Addition(Double, CspTerm) Adds a number and a term.
Public operatorStatic member Addition(Int32, CspTerm) Adds an integer and a term.
Public operatorStatic member Addition(CspTerm, CspTerm) Adds two terms.
Public operatorStatic member Addition(CspTerm, Double) Adds a term and a number.
Public operatorStatic member Addition(CspTerm, Int32) Adds a term and an integer.
Public operatorStatic member BitwiseAnd Performs a bitwise AND operation on two terms.
Public operatorStatic member BitwiseOr Performs a bitwise OR operation on two terms.
Public operatorStatic member GreaterThan(Double, CspTerm) Returns a value that indicates whether a number is greater than a term.
Public operatorStatic member GreaterThan(Int32, CspTerm) Returns a value that indicates whether an integer value is greater than a term.
Public operatorStatic member GreaterThan(CspTerm, CspTerm) Returns a value that indicates whether one term is greater than another term.
Public operatorStatic member GreaterThan(CspTerm, Double) Returns a value that indicates whether a term is greater than a number.
Public operatorStatic member GreaterThan(CspTerm, Int32) Returns a value that indicates whether a term is greater than an integer value..
Public operatorStatic member GreaterThanOrEqual(Double, CspTerm) Returns a value that indicates whether a number is greater than or equal to a term.
Public operatorStatic member GreaterThanOrEqual(Int32, CspTerm) Returns a value that indicates whether an integer value is greater than or equal to a term.
Public operatorStatic member GreaterThanOrEqual(CspTerm, CspTerm) Returns a value that indicates whether one term is greater than or equal to another term.
Public operatorStatic member GreaterThanOrEqual(CspTerm, Double) Returns a value that indicates whether a term is greater than or equal to a number.
Public operatorStatic member GreaterThanOrEqual(CspTerm, Int32) Returns a value that indicates whether a term is greater than or equal to an integer value.
Public operatorStatic member LessThan(Double, CspTerm) Returns a value that indicates whether a number is less than a term.
Public operatorStatic member LessThan(Int32, CspTerm) Returns a value that indicates whether an integer value is less than a term.
Public operatorStatic member LessThan(CspTerm, CspTerm) Returns a value that indicates whether one term is less than another term.
Public operatorStatic member LessThan(CspTerm, Double) Returns a value that indicates whether a term is less than a number.
Public operatorStatic member LessThan(CspTerm, Int32) Returns a value that indicates whether a term is less than an integer value.
Public operatorStatic member LessThanOrEqual(Double, CspTerm) Returns a value that indicates whether a number is less than or equal to a term.
Public operatorStatic member LessThanOrEqual(Int32, CspTerm) Returns a value that indicates whether an integer value is less than or equal to a term.
Public operatorStatic member LessThanOrEqual(CspTerm, CspTerm) Returns a value that indicates whether one term is less than or equal to another term.
Public operatorStatic member LessThanOrEqual(CspTerm, Double) Returns a value that indicates whether a term is less than or equal to a number.
Public operatorStatic member LessThanOrEqual(CspTerm, Int32) Returns a value that indicates whether a term is less than or equal to an integer value.
Public operatorStatic member LogicalNot Performs a logical NOT operation on a term.
Public operatorStatic member Multiply(Double, CspTerm) Multiplies a number by a term.
Public operatorStatic member Multiply(Int32, CspTerm) Multiplies an integer value by a term.
Public operatorStatic member Multiply(CspTerm, CspTerm) Multiplies two terms.
Public operatorStatic member Multiply(CspTerm, Double) Multiplies a term by a number.
Public operatorStatic member Multiply(CspTerm, Int32) Multiplies a term by an integer value.
Public operatorStatic member Subtraction(Double, CspTerm) Subtracts a term from a number.
Public operatorStatic member Subtraction(Int32, CspTerm) Subtracts a term from an integer value.
Public operatorStatic member Subtraction(CspTerm, CspTerm) Subtracts one term from another term.
Public operatorStatic member Subtraction(CspTerm, Double) Subtracts a number from a term.
Public operatorStatic member Subtraction(CspTerm, Int32) Subtracts a number from an integer value.
Public operatorStatic member UnaryNegation Negates a term.

Top

Remarks

A term is not changed by the solving process, and multiple solutions return the same instances for the variables.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SolverFoundation.Solvers Namespace