CspComposite Class

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

Defines a composite data type that consists of a finite set of terms.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Solvers.CspComposite
    Microsoft.SolverFoundation.Solvers.CspPowerList
    Microsoft.SolverFoundation.Solvers.CspPowerSet

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

Syntax

'Declaration
Public Class CspComposite
public class CspComposite
public ref class CspComposite
type CspComposite =  class end
public class CspComposite

The CspComposite type exposes the following members.

Properties

  Name Description
Public property False Gets the Boolean CspTerm {false}.
Public property IsEmpty Returns a value that indicates whether a model in a solver is empty.
Public property Key Gets the key of a composite data type.
Public property True Gets the Boolean CspTerm {true}.

Top

Methods

  Name Description
Public method Abs Computes the absolute value.
Public method AddConstraints Returns a value that indicates whether all composite-wise constraint functions added to a model are valid.
Public method AddField Adds a member.
Public method And Performs a Boolean AND operation.
Public method AtMostMofN Tests that at most m inputs are true.
Public method Constant(Double) Gets a term for the immutable real value k with double precision.
Public method Constant(Int32) Gets a term for the immutable value k.
Public method Constant(Int32, Double) Gets a term for the immutable real value k.
Public method Constant(CspDomain, String) Gets a term for the immutable symbol value k.
Public method Equal(array<CspTerm[]) Tests if all inputs are equal.
Public method Equal(Int32, array<CspTerm[]) Tests if all inputs are equal to a constant.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method ExactlyMofN Tests if exactly m of the inputs are true.
Public method Fields Accesses the field of the composite that has the given key.
Public method FilteredSum Adds the conditional inputs.
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.)
Public method Greater(array<CspTerm[]) Returns a value that indicates whether each input is greater than the following input.
Public method Greater(Int32, array<CspTerm[]) Returns a value that indicates whether a constant is greater than each input.
Public method GreaterEqual(array<CspTerm[]) Returns a value that indicates whether each input is greater than or equal to the following input.
Public method GreaterEqual(Int32, array<CspTerm[]) Returns a value that indicates whether a constant is greater than or equal to the input.
Public method Implies Tests for logical implication between two inputs.
Public method Index(array<CspTerm[], CspTerm) Returns the value of the inputs[index].
Public method Index(array<CspTerm[], array<CspTerm[]) Returns the input value selected by the keys.
Public method Index(array<array<CspTerm[][], CspTerm, CspTerm) Returns the value of the inputs[row][column].
Public method Index(array<array<CspTerm[][], CspTerm, Int32) Returns the value of the inputs[row][column].
Public method Index(array<array<CspTerm[][], Int32, CspTerm) Returns the value of the inputs[row][column].
Public method IsElementOf Returns a value that indicates if an input is a member of a domain.
Public method Less(array<CspTerm[]) Returns a value that indicates if an input is less than the following input.
Public method Less(Int32, array<CspTerm[]) Returns a value that indicates if an input is less than a constant.
Public method LessEqual(array<CspTerm[]) Returns a value that indicates if an input is less than or equal to the following input.
Public method LessEqual(Int32, array<CspTerm[]) Returns a value that indicates if an input is less than or equal to a constant.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Neg Negates the input.
Public method Not Performs the Boolean inverse of the input.
Public method Or Performs the Boolean OR of the inputs.
Public method Power Raises an input to the power of a specified value.
Public method Product Returns the product of the inputs.
Public method Sum Adds the inputs.
Public method SumProduct Performs the sum of the pairwise-product of the inputs.
Public method TableDecimal Creates a relation constraint by using the column variables and inputs.
Public method TableDomain(array<CspTerm[], array<array<CspDomain[][]) Creates a relation constraint by using the column variables and inputs.
Public method TableDomain(array<CspTerm[], IEnumerable<IEnumerable<CspDomain>>) Creates a relation constraint by using the column variables and inputs.
Public method TableInteger Creates a relation constraint by using the column variables and inputs.
Public method TableSymbol Creates a relation constraint by using the column variables and inputs.
Public method TableTerm(array<CspTerm[], array<array<CspTerm[][]) Creates a relation constraint by using the column variables and inputs.
Public method TableTerm(array<CspTerm[], IEnumerable<IEnumerable<CspTerm>>) Creates a relation constraint by using the column variables and inputs.
Public method ToString Converts a CspComposite object to its equivalent string representation. (Overrides Object.ToString().)
Public method Unequal(array<CspTerm[]) Returns a value that indicates if every pairing of the inputs is unequal.
Public method Unequal(Int32, array<CspTerm[]) Returns a value that indicates if every input is unequal to a constant.

Top

Remarks

Each term has its own domain.

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