208

In C# you can put a constraint on a generic method like:

public class A {

    public static void Method<T> (T a) where T : new() {
        //...do something...
    }

}

Where you specify that T should have a constructor that requires no parameters. I'm wondering whether there is a way to add a constraint like "there exists a constructor with a float[,] parameter?"

The following code doesn't compile:

public class A {

    public static void Method<T> (T a) where T : new(float[,] u) {
        //...do something...
    }

}

A workaround is also useful?

Willem Van Onsem
  • 443,496
  • 30
  • 428
  • 555

9 Answers9

170

As you've found, you can't do this.

As a workaround I normally supply a delegate that can create objects of type T:

public class A {

    public static void Method<T> (T a, Func<float[,], T> creator) {
        //...do something...
    }

}
user7116
  • 63,008
  • 17
  • 141
  • 172
Tim Robinson
  • 53,480
  • 10
  • 121
  • 138
  • 66
    are parameterized constructors constraints absent for a logical reason, or is it just something that has yet to be added to the language? – Dave Cousineau Aug 23 '11 at 03:34
  • 49
    Agreed...we should have `new(float, double)`, `new(string)`, etc. – SliverNinja - MSFT Feb 01 '12 at 17:47
  • 12
    @Sahuagin I think it is not possible to do because when you inherit from a class, there's no guarantee that the sub-class has that constructor is defined, as constructors are not inherited. Every class has an empty parameter constructor however. – Matthew Mar 03 '12 at 00:21
  • 46
    @Matthew Not every class has parameterless constructor, if you define a constructor with parameters and dont redefine the default constructor, there's _no_ default constructor. – Johnny5 Apr 30 '12 at 17:58
  • 5
    @Matthew, also if you inherit from a base class you're forced to create matching constructors (unless only the default constructor exists). At least in C# anyway – bc3tech Jul 02 '13 at 17:09
  • 28
    @Matthew That's the whole point of generic type constraints. You require a class, which derives from some class *and contains a constructor with specific parameters*. – Spook Nov 12 '13 at 13:07
  • 2
    @TimRobinson would you provide a sample of calling the method? – Reza Feb 03 '15 at 19:39
  • 17
    @bc3tech, technically, your point is not 100% correct. If a base class has no default constructor, you are forced to provide a constructor that calls one of the base class constructors. You are not forced to provide a matching constructor. There is a subtle difference here... – ghigad Mar 25 '15 at 13:19
  • Also the compiler will supply a default constructor if you don't provide one. – Roberto Bonini Mar 18 '16 at 13:26
  • 6
    @Johnny5 There can only be one Short Circuit – johnny 5 Mar 25 '16 at 19:02
  • I think it may have to do with supplying generic types again into those constructors and somehow ending up in infinite recursion or something, I'm sure they though of it, it seems so obvious. – Daniel Sharp Jul 20 '18 at 21:19
59

Using reflection to create a generic object, the type still needs the correct constructor declared or an exception will be thrown. You can pass in any argument as long as they match one of the constructors.

Used this way you cannot put a constraint on the constructor in the template. If the constructor is missing, an exception needs to be handled at run-time rather than getting an error at compile time.

// public static object CreateInstance(Type type, params object[] args);

// Example 1
T t = (T)Activator.CreateInstance(typeof(T));
// Example 2
T t = (T)Activator.CreateInstance(typeof(T), arg0, arg1, arg2, ...);
// Example 3
T t = (T)Activator.CreateInstance(typeof(T), (string)arg0, (int)arg1, (bool)arg2);
Sam Hanley
  • 4,707
  • 7
  • 35
  • 63
xpress
  • 601
  • 5
  • 3
48

There is no such construct. You can only specify an empty constructor constraint.

I work around this problem with lambda methods.

public static void Method<T>(Func<int,T> del) {
  var t = del(42);
}

Use Case

Method(x => new Foo(x));
JaredPar
  • 733,204
  • 149
  • 1,241
  • 1,454
  • There is no way to abstract the creation of `Foo` inside the `Method`? – wingerse Nov 13 '15 at 15:52
  • What if the user of the `Method` does `Method(x => new Foo());`? Is there anyway to ensure that the lambda should be like that? – wingerse Nov 13 '15 at 15:53
  • What's the benefit of providing a delegate in this situation instead of returning the int and letting the consumer wrap it? It feels like extra boilerplate for no gain. – Josh Oct 12 '18 at 19:42
20

Here is a workaround for this that I personally find quite effective. If you think of what a generic parameterized constructor constraint is, it's really a mapping between types and constructors with a particular signature. You can create your own such mapping by using a dictionary. Put these in a static "factory" class and you can create objects of varying type without having to worry about building a constructor lambda every time:

public static class BaseTypeFactory
{
   private delegate BaseType BaseTypeConstructor(int pParam1, int pParam2);

   private static readonly Dictionary<Type, BaseTypeConstructor>
   mTypeConstructors = new Dictionary<Type, BaseTypeConstructor>
   {
      { typeof(Object1), (pParam1, pParam2) => new Object1(pParam1, pParam2) },
      { typeof(Object2), (pParam1, pParam2) => new Object2(pParam1, pParam2) },
      { typeof(Object3), (pParam1, pParam2) => new Object3(pParam1, pParam2) }
   };

then in your generic method, for example:

   public static T BuildBaseType<T>(...)
      where T : BaseType
   {
      ...
      T myObject = (T)mTypeConstructors[typeof(T)](value1, value2);
      ...
      return myObject;
   }
Dave Cousineau
  • 12,154
  • 8
  • 64
  • 80
  • 1
    I'm using this now, I think it's a good pattern. Works really well with the Factory pattern. Thanks! – Matthew Mar 02 '12 at 20:46
  • This can be extended to create types based on other data as well. I often use this type of construct when parsing IFF-like files. I prefer defining static constructors on the type itself, so my dictionary entries end up looking like ["CELL"] = Cell.CreateInstance, ["WRLD"] = World.CreateInstance, ... –  Feb 15 '19 at 22:13
9

No. At the moment the only constructor constraint you can specify is for a no-arg constructor.

Sean Reilly
  • 21,526
  • 4
  • 48
  • 62
9

I think this is the most clean solution that kind of puts a constraint on the way an object is constructed. It is not entirely compile time checked. When you have the agreement to make the actual constructor of the classes have the same signature like the IConstructor interface, it is kind of like having a constraint on the constructor. The Constructor method is hidden when working normally with the object, because of the explicit interface implementation.

using System.Runtime.Serialization;

namespace ConsoleApp4
{
    class Program
    {
        static void Main(string[] args)
        {
            var employeeWorker = new GenericWorker<Employee>();
            employeeWorker.DoWork();
        }
    }

    public class GenericWorker<T> where T:IConstructor
    {
        public void DoWork()
        {
            T employee = (T)FormatterServices.GetUninitializedObject(typeof(T));
            employee.Constructor("John Doe", 105);
        }
    }

    public interface IConstructor
    {
        void Constructor(string name, int age);
    }

    public class Employee : IConstructor
    {
        public string Name { get; private set; }
        public int Age { get; private set; }

        public Employee(string name, int age)
        {
            ((IConstructor)this).Constructor(name, age);
        }

        void IConstructor.Constructor(string name, int age)
        {
            Name = name;
            Age = age;
        }
    }
}
Mike de Klerk
  • 11,906
  • 8
  • 54
  • 76
  • +1 for providing some compile-time safety that the others don't provide as well as for providing interface support where others don't. – Josh Oct 12 '18 at 19:42
3

How about creating your generic class with constraints, here I chose struct and class to have value and reference types.

That way your constructor has a constraint on the values.

class MyGenericClass<T, X> where T :struct where X: class 
{
    private T genericMemberVariableT;
    private X genericMemberVariableX;
    public MyGenericClass(T valueT, X valueX)
    {
        genericMemberVariableT = valueT;
        genericMemberVariableX = valueX;
    }

    public T genericMethod(T genericParameter)
    {
        Console.WriteLine("Parameter type: {0}, value: {1}", typeof(T).ToString(), genericParameter);
        Console.WriteLine("Return type: {0}, value: {1}", typeof(T).ToString(), genericMemberVariableT);
        Console.WriteLine("Return type: {0}, value: {1}", typeof(X).ToString(), genericMemberVariableX);
        return genericMemberVariableT;
    }

    public T genericProperty { get; set; }
}

Implementation:

        MyGenericClass<int, string> intGenericClass = new MyGenericClass<int, string>(10, "Hello world");
        int val = intGenericClass.genericMethod(200);
3

Here's the recommended workaround by c# maintainers if you'd like to keep the constructor parameter-ful, call the constructor indirectly:

            i = (TService)Activator.CreateInstance(typeof(TService), new object[] {arg});

Where TService is a generic with a parameter-full constructor that I'd like to keep.

If you'd like to read up on how this method works: https://learn.microsoft.com/en-us/dotnet/api/system.activator.createinstance?view=net-5.0#system-activator-createinstance(system-type-system-object-)

Aaaaand discussion by maintainers of C#: https://github.com/dotnet/csharplang/discussions/769

pixelpax
  • 1,435
  • 13
  • 22
0

As alternative (from C# 9+), you can define a interface with "init" properties, as you would to arguments of a constructor. One major benefit is it works for structs or classes.

using System;
                    
public class Program
{
    public interface ITest
    {
        int a { init; }
    }
    public struct Test : ITest{
        public int a { private get; init; }
        public int b => a;
    }   
    public static T TestFunction<T>() where T: ITest, new() {
        return new(){ a = 123 };
    }
    public static void Main()
    {
        var t = TestFunction<Test>();
        Console.WriteLine($"Hello World: {t.b}"); // Prints: Hello World: 123
    }
}