// <copyright file="LinearAlgebraControl.cs" company="Math.NET">
|
// Math.NET Numerics, part of the Math.NET Project
|
// http://numerics.mathdotnet.com
|
// http://github.com/mathnet/mathnet-numerics
|
//
|
// Copyright (c) 2009-2020 Math.NET
|
//
|
// 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.
|
// </copyright>
|
|
using System;
|
|
namespace IStation.Numerics.Providers.LinearAlgebra
|
{
|
public static class LinearAlgebraControl
|
{
|
const string EnvVarLAProvider = "MathNetNumericsLAProvider";
|
const string EnvVarLAProviderPath = "MathNetNumericsLAProviderPath";
|
|
static ILinearAlgebraProvider _linearAlgebraProvider;
|
static readonly object StaticLock = new object();
|
|
/// <summary>
|
/// Gets or sets the linear algebra provider.
|
/// Consider to use UseNativeMKL or UseManaged instead.
|
/// </summary>
|
/// <value>The linear algebra provider.</value>
|
public static ILinearAlgebraProvider Provider
|
{
|
get
|
{
|
if (_linearAlgebraProvider == null)
|
{
|
lock (StaticLock)
|
{
|
if (_linearAlgebraProvider == null)
|
{
|
UseDefault();
|
}
|
}
|
}
|
|
return _linearAlgebraProvider;
|
}
|
set
|
{
|
value.InitializeVerify();
|
|
// only actually set if verification did not throw
|
_linearAlgebraProvider = value;
|
}
|
}
|
|
/// <summary>
|
/// Optional path to try to load native provider binaries from.
|
/// If not set, Numerics will fall back to the environment variable
|
/// `MathNetNumericsLAProviderPath` or the default probing paths.
|
/// </summary>
|
public static string HintPath { get; set; }
|
|
public static ILinearAlgebraProvider CreateManaged()
|
{
|
return new Managed.ManagedLinearAlgebraProvider();
|
}
|
|
public static void UseManaged()
|
{
|
Provider = CreateManaged();
|
}
|
|
internal static ILinearAlgebraProvider CreateManagedReference()
|
{
|
return new ManagedReference.ManagedReferenceLinearAlgebraProvider();
|
}
|
|
internal static void UseManagedReference()
|
{
|
Provider = CreateManagedReference();
|
}
|
|
#if NATIVE
|
[CLSCompliant(false)]
|
public static ILinearAlgebraProvider CreateNativeMKL(
|
Common.Mkl.MklConsistency consistency = Common.Mkl.MklConsistency.Auto,
|
Common.Mkl.MklPrecision precision = Common.Mkl.MklPrecision.Double,
|
Common.Mkl.MklAccuracy accuracy = Common.Mkl.MklAccuracy.High)
|
{
|
return new Mkl.MklLinearAlgebraProvider(GetCombinedHintPath(), consistency, precision, accuracy);
|
}
|
|
[CLSCompliant(false)]
|
public static void UseNativeMKL(
|
Common.Mkl.MklConsistency consistency = Common.Mkl.MklConsistency.Auto,
|
Common.Mkl.MklPrecision precision = Common.Mkl.MklPrecision.Double,
|
Common.Mkl.MklAccuracy accuracy = Common.Mkl.MklAccuracy.High)
|
{
|
Provider = CreateNativeMKL(consistency, precision, accuracy);
|
}
|
|
[CLSCompliant(false)]
|
public static bool TryUseNativeMKL(
|
Common.Mkl.MklConsistency consistency = Common.Mkl.MklConsistency.Auto,
|
Common.Mkl.MklPrecision precision = Common.Mkl.MklPrecision.Double,
|
Common.Mkl.MklAccuracy accuracy = Common.Mkl.MklAccuracy.High)
|
{
|
return TryUse(CreateNativeMKL(consistency, precision, accuracy));
|
}
|
|
public static ILinearAlgebraProvider CreateNativeCUDA()
|
{
|
return new Cuda.CudaLinearAlgebraProvider(GetCombinedHintPath());
|
}
|
|
public static void UseNativeCUDA()
|
{
|
Provider = CreateNativeCUDA();
|
}
|
|
public static bool TryUseNativeCUDA()
|
{
|
return TryUse(CreateNativeCUDA());
|
}
|
|
public static ILinearAlgebraProvider CreateNativeOpenBLAS()
|
{
|
return new OpenBlas.OpenBlasLinearAlgebraProvider(GetCombinedHintPath());
|
}
|
|
public static void UseNativeOpenBLAS()
|
{
|
Provider = CreateNativeOpenBLAS();
|
}
|
|
public static bool TryUseNativeOpenBLAS()
|
{
|
return TryUse(CreateNativeOpenBLAS());
|
}
|
|
/// <summary>
|
/// Try to use a native provider, if available.
|
/// </summary>
|
public static bool TryUseNative()
|
{
|
if (AppSwitches.DisableNativeProviders || AppSwitches.DisableNativeProviderProbing)
|
{
|
return false;
|
}
|
|
return TryUseNativeMKL() || TryUseNativeOpenBLAS() || TryUseNativeCUDA();
|
}
|
#endif
|
|
static bool TryUse(ILinearAlgebraProvider provider)
|
{
|
try
|
{
|
if (!provider.IsAvailable())
|
{
|
return false;
|
}
|
|
Provider = provider;
|
return true;
|
}
|
catch
|
{
|
// intentionally swallow exceptions here - use the explicit variants if you're interested in why
|
return false;
|
}
|
}
|
|
/// <summary>
|
/// Use the best provider available.
|
/// </summary>
|
public static void UseBest()
|
{
|
if (AppSwitches.DisableNativeProviders || AppSwitches.DisableNativeProviderProbing)
|
{
|
UseManaged();
|
return;
|
}
|
|
#if NATIVE
|
if (!TryUseNative())
|
{
|
UseManaged();
|
}
|
#else
|
UseManaged();
|
#endif
|
}
|
|
/// <summary>
|
/// Use a specific provider if configured, e.g. using the
|
/// "MathNetNumericsLAProvider" environment variable,
|
/// or fall back to the best provider.
|
/// </summary>
|
public static void UseDefault()
|
{
|
if (AppSwitches.DisableNativeProviders)
|
{
|
UseManaged();
|
return;
|
}
|
|
#if NATIVE
|
var value = Environment.GetEnvironmentVariable(EnvVarLAProvider);
|
switch (value != null ? value.ToUpperInvariant() : string.Empty)
|
{
|
case "MKL":
|
UseNativeMKL();
|
break;
|
|
case "CUDA":
|
UseNativeCUDA();
|
break;
|
|
case "OPENBLAS":
|
UseNativeOpenBLAS();
|
break;
|
|
default:
|
UseBest();
|
break;
|
}
|
#else
|
UseBest();
|
#endif
|
}
|
|
public static void FreeResources()
|
{
|
Provider.FreeResources();
|
}
|
|
static string GetCombinedHintPath()
|
{
|
if (!String.IsNullOrEmpty(HintPath))
|
{
|
return HintPath;
|
}
|
|
var value = Environment.GetEnvironmentVariable(EnvVarLAProviderPath);
|
if (!String.IsNullOrEmpty(value))
|
{
|
return value;
|
}
|
|
return null;
|
}
|
}
|
}
|
